def create_image_message(self, image: str) -> ToolInvokeMessage: """ Return an image URL message Dify will automatically download the image from the provided URL and display it to the user. Args: image: URL to an image file Returns: ToolInvokeMessage: Message object for the tool response """ pass
def create_link_message(self, link: str) -> ToolInvokeMessage: """ Return a clickable link message Args: link: URL to be displayed as a clickable link Returns: ToolInvokeMessage: Message object for the tool response """ pass
def create_text_message(self, text: str) -> ToolInvokeMessage: """ Return a text message Args: text: Text content to be displayed Returns: ToolInvokeMessage: Message object for the tool response """ pass
def create_blob_message(self, blob: bytes, meta: dict = None) -> ToolInvokeMessage: """ Return a file blob message For returning raw file data such as images, audio, video, or documents (PPT, Word, Excel, etc.) Args: blob: Raw file data in bytes meta: File metadata dictionary. Include 'mime_type' to specify the file type, otherwise 'octet/stream' will be used Returns: ToolInvokeMessage: Message object for the tool response """ pass
def create_json_message(self, json: dict) -> ToolInvokeMessage: """ Return a formatted JSON message Useful for data transmission between workflow nodes. In agent mode, most LLMs can read and understand JSON data. Args: json: Python dictionary to be serialized as JSON Returns: ToolInvokeMessage: Message object for the tool response """ pass
from typing import Anydef create_variable_message(self, variable_name: str, variable_value: Any) -> ToolInvokeMessage: """ Create a named variable for workflow integration For non-streaming output variables. If multiple instances with the same name are created, the latest one overrides previous values. Args: variable_name: Name of the variable to create variable_value: Value of the variable (any Python data type) Returns: ToolInvokeMessage: Message object for the tool response """ pass
def create_stream_variable_message( self, variable_name: str, variable_value: str) -> ToolInvokeMessage: """ Create a streaming variable with typewriter effect When referenced in an answer node in a chatflow application, the text will be output with a typewriter effect. Args: variable_name: Name of the variable to create variable_value: String value to stream (only strings supported) Returns: ToolInvokeMessage: Message object for the tool response """ pass
identity: author: example_author name: example_tool label: en_US: Example Tool zh_Hans: 示例工具 ja_JP: ツール例 pt_BR: Ferramenta de exemplodescription: human: en_US: A simple tool that returns a name zh_Hans: 返回名称的简单工具 ja_JP: 名前を返す簡単なツール pt_BR: Uma ferramenta simples que retorna um nome llm: A simple tool that returns a name variableoutput_schema: type: object properties: name: type: string description: "The name returned by the tool" age: type: integer description: "The age returned by the tool" profile: type: object properties: interests: type: array items: type: string location: type: string
def run(self, inputs): # Process inputs and generate a name generated_name = "Alice" # Return the name as a variable that matches the output_schema return self.create_variable_message("name", generated_name)
def run(self, inputs): # Generate complex structured data user_data = { "name": "Bob", "age": 30, "profile": { "interests": ["coding", "reading", "hiking"], "location": "San Francisco" } } # Return individual variables self.create_variable_message("name", user_data["name"]) self.create_variable_message("age", user_data["age"]) self.create_variable_message("profile", user_data["profile"]) # Also return a text message for display return self.create_text_message(f"User {user_data['name']} processed successfully")
{"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":"6adaffc85acdd37854d01e9e","collectionId":"16feb855-ef63-49d4-8c80-bb506c2406aa","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adaffc85acdd37854d01e9e"},"feedback":{"thumbs":true,"edits":true,"issues":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6adaffc85acdd37854d01e9e","clientVersion":"0.0.3965","searchFilterCounts":[{"language":"en","tag":"Self-Host","count":267},{"language":"ja","tag":"セルフホスト","count":267},{"language":"zh","tag":"自部署","count":267},{"language":"en","tag":"Use","count":183},{"language":"ja","tag":"使い方","count":183},{"language":"zh","tag":"使用","count":183},{"language":"en","tag":"Developer Resources","count":165},{"language":"ja","tag":"開発者リソース","count":165},{"language":"zh","tag":"开发者资源","count":165},{"language":"en","tag":"Cloud","count":112},{"language":"ja","tag":"Cloud","count":112},{"language":"zh","tag":"Cloud","count":112},{"language":"en","tag":"API","count":93},{"language":"ja","tag":"API","count":93},{"language":"zh","tag":"API","count":93},{"language":"en","tag":"Orchestrate","count":80},{"language":"ja","tag":"オーケストレーション","count":80},{"language":"zh","tag":"编排","count":80},{"language":"en","tag":"Workflow \u0026 Chatflow","count":65},{"language":"ja","tag":"Workflow と Chatflow","count":65},{"language":"zh","tag":"Workflow 与 Chatflow","count":65},{"language":"zh","tag":"知识库","count":50},{"language":"en","tag":"Knowledge APIs","count":46},{"language":"ja","tag":"ナレッジ API","count":46},{"language":"zh","tag":"知识库 API","count":46},{"language":"en","tag":"Knowledge","count":44},{"language":"en","tag":"Nodes","count":44},{"language":"ja","tag":"ナレッジ","count":44},{"language":"ja","tag":"ノード","count":44},{"language":"zh","tag":"节点","count":44}],"searchSettings":{"maxResults":12}},"assistantConfig":{},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"body{text-autospace:normal}html[data-current-path=\"/\"] .nav-tabs,html[data-current-path=\"/en/home\"] .nav-tabs,html[data-current-path=\"/ja/home\"] .nav-tabs,html[data-current-path=\"/zh/home\"] .nav-tabs{display:none}#sidebar-content :has(>a[href=\"/en/home\"]),#sidebar-content :has(>a[href=\"/ja/home\"]),#sidebar-content :has(>a[href=\"/zh/home\"]),#sidebar-content a[href=\"/en/home\"],#sidebar-content a[href=\"/ja/home\"],#sidebar-content a[href=\"/zh/home\"]{display:none}.uo-wrap{max-width:64rem;margin:0 auto;padding:2.5rem 2rem 4rem}.uo-hero{display:flex;gap:40px;align-items:center;margin:0 0 48px}.uo-hero-text{flex:1 1 100%}.uo-actions{display:flex;flex-wrap:wrap;align-items:center;gap:20px;margin-top:24px}.uo-cta{display:inline-flex;align-items:center;gap:6px;background:#0060ff;color:#fff!important;padding:8px 18px;border-radius:8px;font-weight:600;text-decoration:none!important;border:0!important}.uo-cta:hover{background:#0034ff}.uo-secondary{font-weight:500}.uo-secondary a{text-decoration:none!important}.uo-secondary a:hover{color:#0060ff}.uo-grid{display:grid;grid-template-columns:repeat(6,minmax(0,1fr));gap:16px}.uo-grid>*{grid-column:span 2;margin:0}.uo-grid>:nth-child(4):nth-last-child(2){grid-column:2/span 2}.uo-help-links{display:flex;flex-wrap:wrap;align-items:center;gap:4px 8px;margin-top:10px;font-weight:500}@media (max-width:900px){.uo-grid{grid-template-columns:1fr}.uo-grid>*,.uo-grid>:nth-child(4):nth-last-child(2){grid-column:auto}}"}],"page":{"pagePath":"ja/develop-plugin/features-and-specs/plugin-types/tool","slug":"/ja/develop-plugin/features-and-specs/plugin-types/tool","pageMetadata":{"dimensions":{"type":{"primary":"reference","detail":"core"},"level":"beginner"},"standard_title":"Tool","language":"ja","title":"ツールの戻り値","description":"ツールプラグインがメッセージ(テキスト、リンク、画像、ファイル、JSON)を返し、標準変数とストリーミング変数を作成し、ワークフロー参照用の出力スキーマを定義する方法","href":"/ja/develop-plugin/features-and-specs/plugin-types/tool"},"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: \"ツールプラグインがメッセージ(テキスト、リンク、画像、ファイル、JSON)を返し、標準変数とストリーミング変数を作成し、ワークフロー参照用の出力スキーマを定義する方法\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,blockquote:`blockquote`,code:`code`,li:`li`,p:`p`,pre:`pre`,span:`span`,ul:`ul`,..._provideComponents(),...props.components},{Accordion,Card,CardGroup,CodeBlock,CodeGroup,Heading,ParamField,Tip,Warning}=_components;if(!Accordion)_missingMdxReference(`Accordion`,true);if(!Card)_missingMdxReference(`Card`,true);if(!CardGroup)_missingMdxReference(`CardGroup`,true);if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!CodeGroup)_missingMdxReference(`CodeGroup`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!Tip)_missingMdxReference(`Tip`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.blockquote,{children:[`\n`,_jsxs(_components.p,{children:[`このドキュメントは AI によって自動翻訳されています。不正確な部分がある場合は、`,_jsx(_components.a,{href:`/en/develop-plugin/features-and-specs/plugin-types/tool`,children:`英語版`}),` を参照してください。`]}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`概要`,children:`概要`}),`\n`,_jsx(_components.p,{children:`ツールは結果をメッセージと変数として返します。このページでは、メッセージインターフェース、変数の作成、出力スキーマの定義について説明します。`}),`\n`,_jsxs(CardGroup,{cols:2,children:[_jsx(Card,{title:`メッセージタイプ`,icon:`comment-dots`,href:`#メッセージの戻り値`,children:_jsx(_components.p,{children:`テキスト、リンク、画像、JSON など、さまざまな種類のメッセージを返す`})}),_jsx(Card,{title:`変数`,icon:`code-branch`,href:`#変数`,children:_jsx(_components.p,{children:`ワークフロー統合のための変数を作成および操作する`})}),_jsx(Card,{title:`出力スキーマ`,icon:`diagram-project`,href:`#カスタム出力変数`,children:_jsx(_components.p,{children:`ワークフロー参照用のカスタム出力変数を定義する`})})]}),`\n`,_jsx(Heading,{level:`2`,id:`データ構造`,children:`データ構造`}),`\n`,_jsx(Heading,{level:`3`,id:`メッセージの戻り値`,children:`メッセージの戻り値`}),`\n`,_jsx(_components.p,{children:`Dify はテキスト、リンク、画像、ファイル blob、JSON など複数のメッセージタイプをサポートしており、それぞれ専用のインターフェースを通じて返されます。`}),`\n`,_jsxs(_components.p,{children:[`デフォルトでは、ワークフロー内のツールの出力には `,_jsx(_components.code,{children:`files`}),`、`,_jsx(_components.code,{children:`text`}),`、`,_jsx(_components.code,{children:`json`}),` の 3 つの固定変数が含まれます。以下のメソッドでこれらの変数を設定します。`]}),`\n`,_jsx(Tip,{children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`create_image_message`}),` などのメソッドで画像を返すこともできますが、ツールはカスタム出力変数もサポートしており、ワークフロー内で特定のデータをより参照しやすくなります。`]})}),`\n`,_jsx(Heading,{level:`3`,id:`メッセージタイプ`,children:`メッセージタイプ`}),`\n`,_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`Image URL`,numberOfLines:`14`,language:`python`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`python`,children:_jsxs(_components.code,{language:`python`,numberOfLines:`14`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`def`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:` create_image_message`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`self`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`image`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:`str`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`) -> ToolInvokeMessage:`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"\"\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` Return an image URL message`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` `})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` Dify will automatically download the image from the provided URL`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` and display it to the user.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` `})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` Args:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` image: URL to an image file`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` `})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` Returns:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` ToolInvokeMessage: Message object for the tool response`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"\"\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` pass`})}),`\n`]})})}),_jsx(CodeBlock,{filename:`Link`,numberOfLines:`11`,language:`python`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`python`,children:_jsxs(_components.code,{language:`python`,numberOfLines:`11`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`def`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:` create_link_message`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`self`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`link`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:`str`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`) -> ToolInvokeMessage:`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"\"\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` Return a clickable link message`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` `})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` Args:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` link: URL to be displayed as a clickable link`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` `})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` Returns:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` ToolInvokeMessage: Message object for the tool response`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"\"\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` pass`})}),`\n`]})})}),_jsx(CodeBlock,{filename:`Text`,numberOfLines:`11`,language:`python`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`python`,children:_jsxs(_components.code,{language:`python`,numberOfLines:`11`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`def`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:` create_text_message`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`self`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`text`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:`str`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`) -> ToolInvokeMessage:`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"\"\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` Return a text message`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` `})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` Args:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` text: Text content to be displayed`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` `})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` Returns:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` ToolInvokeMessage: Message object for the tool response`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"\"\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` pass`})}),`\n`]})})}),_jsx(CodeBlock,{filename:`File`,numberOfLines:`16`,language:`python`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`python`,children:_jsxs(_components.code,{language:`python`,numberOfLines:`16`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`def`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:` create_blob_message`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`self`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`blob`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:`bytes`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`meta`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:`dict`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` None`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`) -> ToolInvokeMessage:`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"\"\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` Return a file blob message`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` `})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` For returning raw file data such as images, audio, video, `})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` or documents (PPT, Word, Excel, etc.)`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` `})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` Args:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` blob: Raw file data in bytes`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` meta: File metadata dictionary. Include 'mime_type' to specify `})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` the file type, otherwise 'octet/stream' will be used`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` `})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` Returns:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` ToolInvokeMessage: Message object for the tool response`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"\"\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` pass`})}),`\n`]})})}),_jsx(CodeBlock,{filename:`JSON`,numberOfLines:`14`,language:`python`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`python`,children:_jsxs(_components.code,{language:`python`,numberOfLines:`14`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`def`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:` create_json_message`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`self`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`json`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:`dict`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`) -> ToolInvokeMessage:`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"\"\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` Return a formatted JSON message`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` `})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` Useful for data transmission between workflow nodes.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` In agent mode, most LLMs can read and understand JSON data.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` `})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` Args:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` json: Python dictionary to be serialized as JSON`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` `})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` Returns:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` ToolInvokeMessage: Message object for the tool response`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"\"\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` pass`})}),`\n`]})})})]}),`\n`,_jsxs(Accordion,{title:`パラメータ`,id:`%E3%83%80%E3%82%A6%E3%83%B3%E3%83%AD%E3%83%BC%E3%83%89%E3%81%97%E3%81%A6%E8%A1%A8%E7%A4%BA%E3%81%95%E3%82%8C%E3%82%8B%E7%94%BB%E5%83%8F%E3%81%AE-url%E3%82%AF%E3%83%AA%E3%83%83%E3%82%AF%E5%8F%AF%E8%83%BD%E3%81%AA%E3%83%AA%E3%83%B3%E3%82%AF%E3%81%A8%E3%81%97%E3%81%A6%E8%A1%A8%E7%A4%BA%E3%81%95%E3%82%8C%E3%82%8B-url%E8%A1%A8%E7%A4%BA%E3%81%95%E3%82%8C%E3%82%8B%E3%83%86%E3%82%AD%E3%82%B9%E3%83%88%E3%82%B3%E3%83%B3%E3%83%86%E3%83%B3%E3%83%84%E3%83%90%E3%82%A4%E3%83%88%E5%BD%A2%E5%BC%8F%E3%81%AE%E7%94%9F%E3%83%95%E3%82%A1%E3%82%A4%E3%83%AB%E3%83%87%E3%83%BC%E3%82%BF%E4%BB%A5%E4%B8%8B%E3%82%92%E5%90%AB%E3%82%80%E3%83%95%E3%82%A1%E3%82%A4%E3%83%AB%E3%83%A1%E3%82%BF%E3%83%87%E3%83%BC%E3%82%BF%EF%BC%9A-mime_type%EF%BC%9A%E3%83%95%E3%82%A1%E3%82%A4%E3%83%AB%E3%81%AE-mime-%E3%82%BF%E3%82%A4%E3%83%97%EF%BC%88%E4%BE%8B%EF%BC%9Aimage%2Fpng%EF%BC%89-%E3%83%95%E3%82%A1%E3%82%A4%E3%83%AB%E3%81%AB%E9%96%A2%E9%80%A3%E3%81%99%E3%82%8B%E3%81%9D%E3%81%AE%E4%BB%96%E3%81%AE%E3%83%A1%E3%82%BF%E3%83%87%E3%83%BC%E3%82%BF-json-%E3%81%A8%E3%81%97%E3%81%A6%E3%82%B7%E3%83%AA%E3%82%A2%E3%83%A9%E3%82%A4%E3%82%BA%E3%81%95%E3%82%8C%E3%82%8B-python-%E8%BE%9E%E6%9B%B8`,children:[_jsx(ParamField,{path:`image`,type:`string`,required:true,id:`param-image`,children:_jsx(_components.p,{children:`ダウンロードして表示される画像の URL`})}),_jsx(ParamField,{path:`link`,type:`string`,required:true,id:`param-link`,children:_jsx(_components.p,{children:`クリック可能なリンクとして表示される URL`})}),_jsx(ParamField,{path:`text`,type:`string`,required:true,id:`param-text`,children:_jsx(_components.p,{children:`表示されるテキストコンテンツ`})}),_jsx(ParamField,{path:`blob`,type:`bytes`,required:true,id:`param-blob`,children:_jsx(_components.p,{children:`バイト形式の生ファイルデータ`})}),_jsxs(ParamField,{path:`meta`,type:`dict`,id:`param-meta`,children:[_jsx(_components.p,{children:`以下を含むファイルメタデータ:`}),_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`mime_type`}),`:ファイルの MIME タイプ(例:`,_jsx(_components.code,{children:`image/png`}),`)`]}),`\n`,_jsx(_components.li,{children:`ファイルに関連するその他のメタデータ`}),`\n`]})]}),_jsx(ParamField,{path:`json`,type:`dict`,required:true,id:`param-json`,children:_jsx(_components.p,{children:`JSON としてシリアライズされる Python 辞書`})})]}),`\n`,_jsx(Tip,{children:_jsxs(_components.p,{children:[`ファイル BLOB を扱う際は、ファイルが正しく処理されるように、`,_jsx(_components.code,{children:`meta`}),` 辞書に常に `,_jsx(_components.code,{children:`mime_type`}),` を指定してください。例:`,_jsx(_components.code,{children:`{\"mime_type\": \"image/png\"}`}),`。`]})}),`\n`,_jsx(Heading,{level:`3`,id:`変数`,children:`変数`}),`\n`,_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`Standard Variable`,numberOfLines:`17`,language:`python`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`python`,children:_jsxs(_components.code,{language:`python`,numberOfLines:`17`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`from`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` typing `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` Any`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`def`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:` create_variable_message`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`self`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`variable_name`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:`str`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`variable_value`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: Any) -> ToolInvokeMessage:`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"\"\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` Create a named variable for workflow integration`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` `})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` For non-streaming output variables. If multiple instances with the `})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` same name are created, the latest one overrides previous values.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` `})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` Args:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` variable_name: Name of the variable to create`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` variable_value: Value of the variable (any Python data type)`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` `})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` Returns:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` ToolInvokeMessage: Message object for the tool response`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"\"\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` pass`})}),`\n`]})})}),_jsx(CodeBlock,{filename:`Streaming Variable`,numberOfLines:`17`,language:`python`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`python`,children:_jsxs(_components.code,{language:`python`,numberOfLines:`17`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`def`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:` create_stream_variable_message`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` self`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`variable_name`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:`str`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`variable_value`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:`str`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`) -> ToolInvokeMessage:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"\"\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` Create a streaming variable with typewriter effect`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` `})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` When referenced in an answer node in a chatflow application,`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` the text will be output with a typewriter effect.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` `})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` Args:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` variable_name: Name of the variable to create`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` variable_value: String value to stream (only strings supported)`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` `})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` Returns:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` ToolInvokeMessage: Message object for the tool response`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"\"\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` pass`})}),`\n`]})})})]}),`\n`,_jsxs(Accordion,{title:`パラメータ`,id:`-1`,children:[_jsx(ParamField,{path:`variable_name`,type:`string`,required:true,id:`param-variable-name`,children:_jsx(_components.p,{children:`作成または更新される変数の名前`})}),_jsxs(ParamField,{path:`variable_value`,type:`Any/string`,required:true,id:`param-variable-value`,children:[_jsx(_components.p,{children:`変数に割り当てる値:`}),_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`標準変数:任意の Python データ型`}),`\n`,_jsx(_components.li,{children:`ストリーミング変数:文字列データのみ`}),`\n`]})]})]}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`create_stream_variable_message`}),` は現在、文字列データのみをサポートしています。複雑なデータ型はタイプライター効果でストリーミングできません。`]})}),`\n`,_jsx(Heading,{level:`2`,id:`カスタム出力変数`,children:`カスタム出力変数`}),`\n`,_jsxs(_components.p,{children:[`Workflow アプリケーションでツールの出力変数を参照するには、ツールのマニフェストで `,_jsx(_components.a,{href:`https://json-schema.org/`,children:`JSON Schema`}),` を使用して、ツールが出力する可能性のある変数を宣言します。`]}),`\n`,_jsx(Heading,{level:`3`,id:`出力スキーマの定義`,children:`出力スキーマの定義`}),`\n`,_jsx(CodeGroup,{children:_jsx(CodeBlock,{filename:`Tool Manifest with Output Schema`,numberOfLines:`33`,language:`yaml`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`yaml`,children:_jsxs(_components.code,{language:`yaml`,numberOfLines:`33`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:`identity`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` author`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`example_author`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` name`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`example_tool`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` label`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` en_US`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`Example Tool`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` zh_Hans`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`示例工具`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` ja_JP`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`ツール例`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` pt_BR`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`Ferramenta de exemplo`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:`description`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` human`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` en_US`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`A simple tool that returns a name`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` zh_Hans`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`返回名称的简单工具`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` ja_JP`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`名前を返す簡単なツール`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` pt_BR`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`Uma ferramenta simples que retorna um nome`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` llm`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`A simple tool that returns a name variable`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:`output_schema`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` type`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`object`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` properties`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` name`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` type`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`string`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` description`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"The name returned by the tool\"`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` age`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` type`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`integer`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` description`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"The age returned by the tool\"`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` profile`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` type`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`object`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` properties`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` interests`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` type`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`array`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` items`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` type`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`string`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` location`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` type`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`string`})]}),`\n`]})})})}),`\n`,_jsxs(Accordion,{title:`スキーマ構造`,id:`-2`,children:[_jsx(ParamField,{path:`output_schema`,type:`object`,required:true,id:`param-output-schema`,children:_jsx(_components.p,{children:`ツールの出力スキーマを定義するルートオブジェクト`})}),_jsx(ParamField,{path:`type`,type:`string`,required:true,id:`param-type`,children:_jsxs(_components.p,{children:[`ツール出力スキーマでは `,_jsx(_components.code,{children:`object`}),` である必要があります`]})}),_jsx(ParamField,{path:`properties`,type:`object`,required:true,id:`param-properties`,children:_jsx(_components.p,{children:`すべての可能な出力変数の辞書`})}),_jsx(ParamField,{path:`properties.[variable_name]`,type:`object`,id:`param-properties-variable-name`,children:_jsx(_components.p,{children:`各出力変数の定義(型と説明を含む)`})})]}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[`出力スキーマを定義するだけでは不十分です。実装コードで `,_jsx(_components.code,{children:`create_variable_message()`}),` を使用して各変数を返す必要があります。そうしないと、ワークフローはその変数に対して `,_jsx(_components.code,{children:`None`}),` を受け取ります。`]})}),`\n`,_jsx(Heading,{level:`3`,id:`実装例`,children:`実装例`}),`\n`,_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`Basic Variable Example`,numberOfLines:`6`,language:`python`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`python`,children:_jsxs(_components.code,{language:`python`,numberOfLines:`6`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`def`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:` run`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`self`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`inputs`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`):`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:` # Process inputs and generate a name`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` generated_name `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Alice\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` `})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:` # Return the name as a variable that matches the output_schema`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` return`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` self`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.create_variable_message(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, generated_name)`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`Complex Structure Example`,numberOfLines:`18`,language:`python`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`python`,children:_jsxs(_components.code,{language:`python`,numberOfLines:`18`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`def`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:` run`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`self`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`inputs`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`):`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:` # Generate complex structured data`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` user_data `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Bob\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"age\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`30`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"profile\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"interests\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"coding\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"reading\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"hiking\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`],`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"location\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"San Francisco\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` `})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:` # Return individual variables`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` self`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.create_variable_message(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, user_data[`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`])`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` self`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.create_variable_message(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"age\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, user_data[`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"age\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`])`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` self`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.create_variable_message(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"profile\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, user_data[`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"profile\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`])`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` `})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:` # Also return a text message for display`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` return`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` self`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.create_text_message(`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`f`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"User `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`{`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`user_data[`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'name'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`]`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`}`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` processed successfully\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})]}),`\n`]})})})]}),`\n`,_jsx(Tip,{children:_jsx(_components.p,{children:`複雑なワークフローの場合、複数の出力変数を定義してすべてを返すことができます。これにより、ワークフロー設計者がツールを使用する際の柔軟性が向上します。`})}),`\n`,_jsx(Heading,{level:`2`,id:`例`,children:`例`}),`\n`,_jsx(Heading,{level:`3`,id:`完全なツール実装`,children:`完全なツール実装`}),`\n`,_jsx(CodeGroup,{children:_jsx(CodeBlock,{filename:`Weather Forecast Tool`,numberOfLines:`42`,language:`python`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`python`,children:_jsxs(_components.code,{language:`python`,numberOfLines:`42`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` requests`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`from`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` typing `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` Any`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`class`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#4EC9B0`},children:` WeatherForecastTool`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:` def`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:` run`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`self`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`inputs`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:`dict`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`) -> Any:`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:` # Get location from inputs`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` location `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` inputs.get(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"location\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"London\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` `})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` try`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:` # Call weather API (example only)`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` weather_data `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` self`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`._get_weather_data(location)`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` `})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:` # Create variables for workflow use`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` self`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.create_variable_message(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"temperature\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, weather_data[`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"temperature\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`])`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` self`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.create_variable_message(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"conditions\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, weather_data[`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"conditions\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`])`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` self`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.create_variable_message(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"forecast\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, weather_data[`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"forecast\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`])`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` `})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:` # Create a JSON message for data transmission`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` self`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.create_json_message(weather_data)`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` `})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:` # Create an image message for the weather map`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` self`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.create_image_message(weather_data[`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"map_url\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`])`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` `})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:` # Return a formatted text response`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` return`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` self`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.create_text_message(`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:` f`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Weather in `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`{`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`location`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`}`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`: `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`{`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`weather_data[`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'temperature'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`]`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`}`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`°C, `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`{`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`weather_data[`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'conditions'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`]`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`}`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`. \"`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:` f`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Forecast: `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`{`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`weather_data[`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'forecast'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`]`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`}`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` )`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` `})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` except`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:` Exception`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` as`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` e:`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:` # Handle errors gracefully`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` return`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` self`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.create_text_message(`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`f`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Error retrieving weather data: `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`{`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:`str`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(e)`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`}`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` `})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:` def`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:` _get_weather_data`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`self`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`location`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:`str`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`) -> `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:`dict`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:` # Mock implementation - in a real tool, this would call a weather API`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` return`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"location\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: location,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"temperature\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`22`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"conditions\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Partly Cloudy\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"forecast\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Sunny with occasional showers tomorrow\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"map_url\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://example.com/weather-map.png\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`]})})})}),`\n`,_jsx(Tip,{children:_jsx(_components.p,{children:`ツールを設計する際は、直接出力(ユーザーが見るもの)と変数出力(他のワークフローノードが使用できるもの)の両方を考慮してください。この分離により、ツールの使用方法に柔軟性が生まれます。`})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"dimensions":{"type":{"primary":"reference","detail":"core"},"level":"beginner"},"standard_title":"Tool","language":"ja","title":"ツールの戻り値","description":"ツールプラグインがメッセージ(テキスト、リンク、画像、ファイル、JSON)を返し、標準変数とストリーミング変数を作成し、ワークフロー参照用の出力スキーマを定義する方法","href":"/ja/develop-plugin/features-and-specs/plugin-types/tool"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"概要","slug":"概要","depth":2,"children":[]},{"title":"データ構造","slug":"データ構造","depth":2,"children":[{"title":"メッセージの戻り値","slug":"メッセージの戻り値","depth":3,"children":[]},{"title":"メッセージタイプ","slug":"メッセージタイプ","depth":3,"children":[]},{"title":"変数","slug":"変数","depth":3,"children":[]}]},{"title":"カスタム出力変数","slug":"カスタム出力変数","depth":2,"children":[{"title":"出力スキーマの定義","slug":"出力スキーマの定義","depth":3,"children":[]},{"title":"実装例","slug":"実装例","depth":3,"children":[]}]},{"title":"例","slug":"例","depth":2,"children":[{"title":"完全なツール実装","slug":"完全なツール実装","depth":3,"children":[]}]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/dify-6c0370d8/90066d529e522771/contributing-footer.js"],"subdomain":"dify-6c0370d8","siteName":"Dify Docs","title":"ツールの戻り値 - Dify Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-07-09T10:25:05.354Z","gitLastModified":"2026-07-09T10:23:53.000Z","originalFileLocation":"ja/develop-plugin/features-and-specs/plugin-types/tool.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=\"ツールプラグインがメッセージ(テキスト、リンク、画像、ファイル、JSON)を返し、標準変数とストリーミング変数を作成し、ワークフロー参照用の出力スキーマを定義する方法\">\u003cmeta data-mint-head name=\"application-name\" content=\"Dify Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/dify-6c0370d8/tWYYD8GkT0MUJV0z/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/dify-6c0370d8/tWYYD8GkT0MUJV0z/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/dify-6c0370d8/tWYYD8GkT0MUJV0z/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/dify-6c0370d8/tWYYD8GkT0MUJV0z/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/dify-6c0370d8/tWYYD8GkT0MUJV0z/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/dify-6c0370d8/tWYYD8GkT0MUJV0z/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/dify-6c0370d8/tWYYD8GkT0MUJV0z/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/dify-6c0370d8/tWYYD8GkT0MUJV0z/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/dify-6c0370d8/tWYYD8GkT0MUJV0z/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"ツールの戻り値 - Dify Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"ツールプラグインがメッセージ(テキスト、リンク、画像、ファイル、JSON)を返し、標準変数とストリーミング変数を作成し、ワークフロー参照用の出力スキーマを定義する方法\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Dify Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.dify.ai/ja/develop-plugin/features-and-specs/plugin-types/tool\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://dify-6c0370d8.mintlify.app/_mintlify/api/og/v2?division=%E3%83%97%E3%83%A9%E3%82%B0%E3%82%A4%E3%83%B3%E3%82%BF%E3%82%A4%E3%83%97\u0026amp;title=%E3%83%84%E3%83%BC%E3%83%AB%E3%81%AE%E6%88%BB%E3%82%8A%E5%80%A4\u0026amp;description=%E3%83%84%E3%83%BC%E3%83%AB%E3%83%97%E3%83%A9%E3%82%B0%E3%82%A4%E3%83%B3%E3%81%8C%E3%83%A1%E3%83%83%E3%82%BB%E3%83%BC%E3%82%B8%EF%BC%88%E3%83%86%E3%82%AD%E3%82%B9%E3%83%88%E3%80%81%E3%83%AA%E3%83%B3%E3%82%AF%E3%80%81%E7%94%BB%E5%83%8F%E3%80%81%E3%83%95%E3%82%A1%E3%82%A4%E3%83%AB%E3%80%81JSON%EF%BC%89%E3%82%92%E8%BF%94%E3%81%97%E3%80%81%E6%A8%99%E6%BA%96%E5%A4%89%E6%95%B0%E3%81%A8%E3%82%B9%E3%83%88%E3%83%AA%E3%83%BC%E3%83%9F%E3%83%B3%E3%82%B0%E5%A4%89%E6%95%B0%E3%82%92%E4%BD%9C%E6%88%90%E3%81%97%E3%80%81%E3%83%AF%E3%83%BC%E3%82%AF%E3%83%95%E3%83%AD%E3%83%BC%E5%8F%82%E7%85%A7%E7%94%A8%E3%81%AE%E5%87%BA%E5%8A%9B%E3%82%B9%E3%82%AD%E3%83%BC%E3%83%9E%E3%82%92%E5%AE%9A%E7%BE%A9%E3%81%99%E3%82%8B%E6%96%B9%E6%B3%95\u0026amp;theme=fc270d2c96587e5833522f0e\u0026amp;signature=c7b4c1329ff8a37e31cadf902d875639ef43cc3faa9a422c5c86b219d864e920\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"ツールの戻り値 - Dify Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"ツールプラグインがメッセージ(テキスト、リンク、画像、ファイル、JSON)を返し、標準変数とストリーミング変数を作成し、ワークフロー参照用の出力スキーマを定義する方法\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://dify-6c0370d8.mintlify.app/_mintlify/api/og/v2?division=%E3%83%97%E3%83%A9%E3%82%B0%E3%82%A4%E3%83%B3%E3%82%BF%E3%82%A4%E3%83%97\u0026amp;title=%E3%83%84%E3%83%BC%E3%83%AB%E3%81%AE%E6%88%BB%E3%82%8A%E5%80%A4\u0026amp;description=%E3%83%84%E3%83%BC%E3%83%AB%E3%83%97%E3%83%A9%E3%82%B0%E3%82%A4%E3%83%B3%E3%81%8C%E3%83%A1%E3%83%83%E3%82%BB%E3%83%BC%E3%82%B8%EF%BC%88%E3%83%86%E3%82%AD%E3%82%B9%E3%83%88%E3%80%81%E3%83%AA%E3%83%B3%E3%82%AF%E3%80%81%E7%94%BB%E5%83%8F%E3%80%81%E3%83%95%E3%82%A1%E3%82%A4%E3%83%AB%E3%80%81JSON%EF%BC%89%E3%82%92%E8%BF%94%E3%81%97%E3%80%81%E6%A8%99%E6%BA%96%E5%A4%89%E6%95%B0%E3%81%A8%E3%82%B9%E3%83%88%E3%83%AA%E3%83%BC%E3%83%9F%E3%83%B3%E3%82%B0%E5%A4%89%E6%95%B0%E3%82%92%E4%BD%9C%E6%88%90%E3%81%97%E3%80%81%E3%83%AF%E3%83%BC%E3%82%AF%E3%83%95%E3%83%AD%E3%83%BC%E5%8F%82%E7%85%A7%E7%94%A8%E3%81%AE%E5%87%BA%E5%8A%9B%E3%82%B9%E3%82%AD%E3%83%BC%E3%83%9E%E3%82%92%E5%AE%9A%E7%BE%A9%E3%81%99%E3%82%8B%E6%96%B9%E6%B3%95\u0026amp;theme=fc270d2c96587e5833522f0e\u0026amp;signature=c7b4c1329ff8a37e31cadf902d875639ef43cc3faa9a422c5c86b219d864e920\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/dify-6c0370d8/tWYYD8GkT0MUJV0z/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Dify Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0060FF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.dify.ai/ja/develop-plugin/features-and-specs/plugin-types/tool\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/ja/develop-plugin/features-and-specs/plugin-types/tool.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.dify.ai/#organization\",\"name\":\"Dify Docs\",\"url\":\"https://docs.dify.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://assets-docs.dify.ai/2025/05/d05cfc6ebe48f725d171dc71c64a5d16.svg\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.dify.ai#website\",\"name\":\"Dify Docs\",\"url\":\"https://docs.dify.ai\",\"publisher\":{\"@id\":\"https://docs.dify.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.dify.ai/ja/develop-plugin/features-and-specs/plugin-types/tool#webpage\",\"url\":\"https://docs.dify.ai/ja/develop-plugin/features-and-specs/plugin-types/tool\",\"name\":\"ツールの戻り値\",\"description\":\"ツールプラグインがメッセージ(テキスト、リンク、画像、ファイル、JSON)を返し、標準変数とストリーミング変数を作成し、ワークフロー参照用の出力スキーマを定義する方法\",\"dateModified\":\"2026-07-09T10:23:53.000Z\",\"isPartOf\":{\"@id\":\"https://docs.dify.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.dify.ai/ja/develop-plugin/features-and-specs/plugin-types/tool#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.dify.ai/ja/develop-plugin/features-and-specs/plugin-types/tool#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"特性と仕様\",\"item\":\"https://docs.dify.ai/ja/develop-plugin/features-and-specs/plugin-types/general-specifications\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"プラグインタイプ\",\"item\":\"https://docs.dify.ai/ja/develop-plugin/features-and-specs/plugin-types/general-specifications\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"ツールの戻り値\",\"item\":\"https://docs.dify.ai/ja/develop-plugin/features-and-specs/plugin-types/tool\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.dify.ai/ja/develop-plugin/features-and-specs/plugin-types/tool#article\",\"headline\":\"ツールの戻り値\",\"name\":\"ツールの戻り値\",\"description\":\"ツールプラグインがメッセージ(テキスト、リンク、画像、ファイル、JSON)を返し、標準変数とストリーミング変数を作成し、ワークフロー参照用の出力スキーマを定義する方法\",\"url\":\"https://docs.dify.ai/ja/develop-plugin/features-and-specs/plugin-types/tool\",\"mainEntityOfPage\":{\"@id\":\"https://docs.dify.ai/ja/develop-plugin/features-and-specs/plugin-types/tool#webpage\"},\"dateModified\":\"2026-07-09T10:23:53.000Z\",\"publisher\":{\"@id\":\"https://docs.dify.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.dify.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Dify Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Dify Docs","nav":{"global":null,"languages":[{"language":"en","default":true,"products":[{"product":"Cloud","icon":"cloud","tabs":[{"tab":"Use","icon":"book-open","pages":[{"title":"Use Dify","sidebarTitle":"Overview","mode":"frame","href":"/en/cloud/use-dify/getting-started/introduction"},{"title":"Dify Documentation","mode":"custom","hidden":true,"href":"/en/home"},{"group":"Orchestrate","icon":"hammer","pages":[{"group":"Workflow \u0026 Chatflow","expanded":false,"pages":[{"title":"Workflow \u0026 Chatflow","sidebarTitle":"Overview","href":"/en/cloud/use-dify/build/workflow-chatflow"},{"title":"Orchestration Logic","href":"/en/cloud/use-dify/build/orchestrate-node"},{"group":"Nodes","expanded":false,"pages":[{"group":"Start","root":{"title":"Start Node","href":"/en/cloud/use-dify/nodes/start"},"pages":[{"title":"User Input","href":"/en/cloud/use-dify/nodes/user-input"},{"group":"Trigger","root":{"title":"Trigger","sidebarTitle":"Overview","href":"/en/cloud/use-dify/nodes/trigger/overview"},"pages":[{"title":"Schedule Trigger","href":"/en/cloud/use-dify/nodes/trigger/schedule-trigger"},{"title":"Integration Trigger","href":"/en/cloud/use-dify/nodes/trigger/plugin-trigger"},{"title":"Webhook Trigger","href":"/en/cloud/use-dify/nodes/trigger/webhook-trigger"}]}]},{"title":"LLM","href":"/en/cloud/use-dify/nodes/llm"},{"title":"Knowledge Retrieval","href":"/en/cloud/use-dify/nodes/knowledge-retrieval"},{"title":"Answer","href":"/en/cloud/use-dify/nodes/answer"},{"title":"Output","href":"/en/cloud/use-dify/nodes/output"},{"title":"Agent","href":"/en/cloud/use-dify/nodes/agent"},{"title":"Question Classifier","href":"/en/cloud/use-dify/nodes/question-classifier"},{"title":"If-Else","href":"/en/cloud/use-dify/nodes/ifelse"},{"group":"Human Input","root":{"title":"Human Input","href":"/en/cloud/use-dify/nodes/human-input"},"expanded":false,"pages":[]},{"title":"Iteration","href":"/en/cloud/use-dify/nodes/iteration"},{"title":"Loop","href":"/en/cloud/use-dify/nodes/loop"},{"title":"Code","href":"/en/cloud/use-dify/nodes/code"},{"title":"Template","href":"/en/cloud/use-dify/nodes/template"},{"title":"Variable Aggregator","href":"/en/cloud/use-dify/nodes/variable-aggregator"},{"title":"Document Extractor","href":"/en/cloud/use-dify/nodes/doc-extractor"},{"title":"Variable Assigner","href":"/en/cloud/use-dify/nodes/variable-assigner"},{"title":"Parameter Extractor","href":"/en/cloud/use-dify/nodes/parameter-extractor"},{"title":"HTTP Request","href":"/en/cloud/use-dify/nodes/http-request"},{"title":"List Operator","href":"/en/cloud/use-dify/nodes/list-operator"},{"title":"Tool Node","sidebarTitle":"Tool","href":"/en/cloud/use-dify/nodes/tools"}]},{"title":"Hotkeys","href":"/en/cloud/use-dify/build/shortcut-key"},{"title":"Version Control","href":"/en/cloud/use-dify/build/version-control"},{"title":"Snippets","sidebarTitle":"Snippets","href":"/en/cloud/use-dify/build/snippet"},{"group":"Debug","expanded":false,"pages":[{"title":"Handle Errors","href":"/en/cloud/use-dify/build/predefined-error-handling-logic"},{"title":"Single Node","href":"/en/cloud/use-dify/debug/step-run"},{"title":"Variable Inspector","href":"/en/cloud/use-dify/debug/variable-inspect"},{"title":"Run History","href":"/en/cloud/use-dify/debug/history-and-logs"},{"title":"Error Types","href":"/en/cloud/use-dify/debug/error-type"}]}]},{"group":"Agent","tag":"New","expanded":false,"pages":[{"title":"Agent","sidebarTitle":"Overview","href":"/en/cloud/use-dify/build/new-agent/overview"},{"title":"Build an Agent","sidebarTitle":"Build","href":"/en/cloud/use-dify/build/new-agent/build"}]},{"group":"Basic Apps","expanded":false,"pages":[{"title":"Agent","tag":"Legacy","href":"/en/cloud/use-dify/build/agent"},{"title":"Chatbot","sidebarTitle":"Chatbot","href":"/en/cloud/use-dify/build/chatbot"},{"title":"Text Generator","sidebarTitle":"Text Generator","href":"/en/cloud/use-dify/build/text-generator"}]},{"title":"App Toolkit","href":"/en/cloud/use-dify/build/additional-features"},{"title":"Go to Anything","href":"/en/cloud/use-dify/build/goto-anything"}]},{"group":"Publish","icon":"paper-plane","expanded":false,"pages":[{"title":"Overview","href":"/en/cloud/use-dify/publish/README"},{"group":"Web App","pages":[{"title":"Workflow Web Apps","href":"/en/cloud/use-dify/publish/webapp/workflow-webapp"},{"title":"Chat Web Apps","href":"/en/cloud/use-dify/publish/webapp/chatflow-webapp"},{"title":"Settings","href":"/en/cloud/use-dify/publish/webapp/web-app-settings"},{"title":"Embed Your Web App","sidebarTitle":"Embeds","href":"/en/cloud/use-dify/publish/webapp/embedding-in-websites"}]},{"title":"MCP Server","href":"/en/cloud/use-dify/publish/publish-mcp"},{"title":"Publish Apps to Marketplace","sidebarTitle":"Marketplace","href":"/en/cloud/use-dify/publish/publish-to-marketplace"}]},{"group":"Monitor","icon":"chart-line","expanded":false,"pages":[{"title":"Dashboard","href":"/en/cloud/use-dify/monitor/analysis"},{"title":"Logs","href":"/en/cloud/use-dify/monitor/logs"},{"title":"Annotation System","href":"/en/cloud/use-dify/monitor/annotation-reply"},{"group":"Integrations","pages":[{"title":"Integrate with LangSmith","sidebarTitle":"LangSmith","href":"/en/cloud/use-dify/monitor/integrations/integrate-langsmith"},{"title":"Integrate with Langfuse","sidebarTitle":"Langfuse","href":"/en/cloud/use-dify/monitor/integrations/integrate-langfuse"},{"title":"Integrate with Opik","sidebarTitle":"Opik","href":"/en/cloud/use-dify/monitor/integrations/integrate-opik"},{"title":"Integrate with W\u0026B Weave","sidebarTitle":"W\u0026B Weave","href":"/en/cloud/use-dify/monitor/integrations/integrate-weave"},{"title":"Integrate with Arize","sidebarTitle":"Arize","href":"/en/cloud/use-dify/monitor/integrations/integrate-arize"},{"title":"Integrate with Phoenix","sidebarTitle":"Phoenix","href":"/en/cloud/use-dify/monitor/integrations/integrate-phoenix"},{"title":"Integrate with Alibaba Cloud Monitor","sidebarTitle":"Alibaba Cloud Monitor","href":"/en/cloud/use-dify/monitor/integrations/integrate-aliyun"}]}]},{"group":"Knowledge","icon":"book","expanded":false,"pages":[{"title":"Knowledge","sidebarTitle":"Overview","href":"/en/cloud/use-dify/knowledge/readme"},{"group":"Create","pages":[{"group":"Ready-to-Use Knowledge Base","pages":[{"title":"Create a Ready-to-Use Knowledge Base","sidebarTitle":"Overview","href":"/en/cloud/use-dify/knowledge/create-knowledge/introduction"},{"group":"Import Data","pages":[{"title":"Upload Local Files","href":"/en/cloud/use-dify/knowledge/create-knowledge/import-text-data/readme"},{"title":"Sync Data from Notion","href":"/en/cloud/use-dify/knowledge/create-knowledge/import-text-data/sync-from-notion"},{"title":"Import Data from Website","href":"/en/cloud/use-dify/knowledge/create-knowledge/import-text-data/sync-from-website"}]},{"title":"Configure the Chunk Settings","href":"/en/cloud/use-dify/knowledge/create-knowledge/chunking-and-cleaning-text"},{"title":"Specify the Index Method and Retrieval Settings","href":"/en/cloud/use-dify/knowledge/create-knowledge/setting-indexing-methods"}]},{"group":"Custom Knowledge Base","pages":[{"title":"Build a Custom Knowledge Base","sidebarTitle":"Overview","href":"/en/cloud/use-dify/knowledge/knowledge-pipeline/readme"},{"title":"Step 1: Create Knowledge Pipeline","href":"/en/cloud/use-dify/knowledge/knowledge-pipeline/create-knowledge-pipeline"},{"title":"Step 2: Orchestrate Knowledge Pipeline","href":"/en/cloud/use-dify/knowledge/knowledge-pipeline/knowledge-pipeline-orchestration"},{"title":"Step 3: Publish Knowledge Pipeline","href":"/en/cloud/use-dify/knowledge/knowledge-pipeline/publish-knowledge-pipeline"},{"title":"Step 4: Upload Files","href":"/en/cloud/use-dify/knowledge/knowledge-pipeline/upload-files"},{"title":"Step 5: Manage and Use Knowledge Base","href":"/en/cloud/use-dify/knowledge/knowledge-pipeline/manage-knowledge-base"},{"title":"Authorize Data Source","href":"/en/cloud/use-dify/knowledge/knowledge-pipeline/authorize-data-source"}]},{"group":"Connect to External Knowledge","pages":[{"title":"Connect to External Knowledge Base","sidebarTitle":"Overview","href":"/en/cloud/use-dify/knowledge/connect-external-knowledge-base"},{"title":"External Knowledge API","href":"/en/cloud/use-dify/knowledge/external-knowledge-api"}]}]},{"group":"Manage","pages":[{"title":"Manage Knowledge Content","sidebarTitle":"Documents \u0026 Chunks","href":"/en/cloud/use-dify/knowledge/manage-knowledge/maintain-knowledge-documents"},{"title":"Manage Document Metadata","sidebarTitle":"Metadata","href":"/en/cloud/use-dify/knowledge/metadata"},{"title":"Manage Knowledge Settings","sidebarTitle":"Settings","href":"/en/cloud/use-dify/knowledge/manage-knowledge/introduction"}]},{"title":"Test Knowledge Retrieval","sidebarTitle":"Test Retrieval","href":"/en/cloud/use-dify/knowledge/test-retrieval"},{"title":"Integrate Knowledge within Apps","sidebarTitle":"Integrate in Apps","href":"/en/cloud/use-dify/knowledge/integrate-knowledge-within-application"},{"title":"Knowledge Request Rate Limit","sidebarTitle":"Request Rate Limit","href":"/en/cloud/use-dify/knowledge/knowledge-request-rate-limit"},{"title":"Knowledge Data Storage Limit","sidebarTitle":"Data Storage Limit","href":"/en/cloud/use-dify/knowledge/knowledge-storage-limit"}]},{"group":"Integrations","icon":"plug","expanded":false,"pages":[{"title":"Integrations","sidebarTitle":"Overview","href":"/en/cloud/use-dify/workspace/plugins"},{"title":"Model Providers","href":"/en/cloud/use-dify/workspace/model-providers"},{"title":"Dify Tools","sidebarTitle":"Tools","href":"/en/cloud/use-dify/workspace/tools"},{"group":"Custom Endpoint","pages":[{"title":"Custom Endpoints","sidebarTitle":"Overview","href":"/en/cloud/use-dify/workspace/api-extension/api-extension"},{"title":"External Data Tool","href":"/en/cloud/use-dify/workspace/api-extension/external-data-tool-api-extension"},{"title":"Sensitive Content Moderation","href":"/en/cloud/use-dify/workspace/api-extension/moderation-api-extension"},{"title":"Deploy Custom Endpoints Using Cloudflare Workers","href":"/en/cloud/use-dify/workspace/api-extension/cloudflare-worker"}]}]},{"group":"Workspace","icon":"briefcase","expanded":false,"pages":[{"title":"Overview","href":"/en/cloud/use-dify/workspace/readme"},{"title":"Manage Apps","href":"/en/cloud/use-dify/workspace/app-management"},{"title":"Manage Members","href":"/en/cloud/use-dify/workspace/team-members-management"},{"title":"Personal Settings","href":"/en/cloud/use-dify/workspace/personal-account-management"},{"title":"Billing","href":"/en/cloud/use-dify/workspace/subscription-management"}]}]},{"tab":"Learn","icon":"graduation-cap","pages":[{"title":"Key Concepts","href":"/en/learn/key-concepts"},{"group":"Tutorials","pages":[{"title":"30-Minute Quick Start","href":"/en/quick-start"},{"group":"Workflow 101","pages":[{"title":"Lesson 1: What is a Workflow?","href":"/en/learn/tutorials/workflow-101/lesson-01"},{"title":"Lesson 2: Head and Tail (Start \u0026 Output Node)","sidebarTitle":"Lesson 2: Head and Tail","href":"/en/learn/tutorials/workflow-101/lesson-02"},{"title":"Lesson 3: The Brain of the Workflow (LLM Node)","sidebarTitle":"Lesson 3: The Brain of the Workflow","href":"/en/learn/tutorials/workflow-101/lesson-03"},{"title":"Lesson 4: The Cheat Sheet (Knowledge Retrieval)","sidebarTitle":"Lesson 4: The Cheat Sheet","href":"/en/learn/tutorials/workflow-101/lesson-04"},{"title":"Lesson 5: The Crossroads of Your Workflow (Sorting and Executing)","sidebarTitle":"Lesson 5: The Crossroads of Your Workflow","href":"/en/learn/tutorials/workflow-101/lesson-05"},{"title":"Lesson 6: Handle Multiple Tasks (Parameter Extraction \u0026 Iteration)","sidebarTitle":"Lesson 6: Handle Multiple Tasks","href":"/en/learn/tutorials/workflow-101/lesson-06"},{"title":"Lesson 7: Enhance Workflows (Tools)","sidebarTitle":"Lesson 7: Enhance Workflows","href":"/en/learn/tutorials/workflow-101/lesson-07"},{"title":"Lesson 8: The Agent Node","sidebarTitle":"Lesson 8: The Agent Node","href":"/en/learn/tutorials/workflow-101/lesson-08"},{"title":"Lesson 9: Layout Designer (Template)","sidebarTitle":"Lesson 9: Layout Designer","href":"/en/learn/tutorials/workflow-101/lesson-09"},{"title":"Lesson 10: Publish and Monitor Your AI App","sidebarTitle":"Lesson 10: Publish and Monitor","href":"/en/learn/tutorials/workflow-101/lesson-10"}]},{"title":"Simple Chatbot","href":"/en/learn/tutorials/simple-chatbot"},{"title":"Twitter Account Analyzer","href":"/en/learn/tutorials/twitter-chatflow"},{"title":"Customer Service Bot With Knowledge Base","href":"/en/learn/tutorials/customer-service-bot"},{"title":"AI Image Generation App","href":"/en/learn/tutorials/build-ai-image-generation-app"},{"title":"Article Reader Using File Upload","href":"/en/learn/tutorials/article-reader"}]}]},{"tab":"Developer Resources","icon":"code","menu":[{"item":"API","icon":"code","groups":[{"group":"Guides","pages":[{"title":"Get Started with the Dify API","sidebarTitle":"Get Started","href":"/en/api-reference/guides/get-started"},{"group":"API Overviews","expanded":true,"pages":[{"title":"Chatflow App API","sidebarTitle":"Chatflow","href":"/en/api-reference/guides/chatflow"},{"title":"Workflow App API","sidebarTitle":"Workflow","href":"/en/api-reference/guides/workflow"},{"title":"Agent API","sidebarTitle":"Agent","tag":"New","href":"/en/api-reference/guides/agent"},{"title":"Knowledge API","sidebarTitle":"Knowledge","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":"Knowledge Bases","pages":[{"title":"Create an Empty Knowledge Base","deprecated":null,"version":null,"sidebarTitle":"Create an Empty Knowledge Base","openapi":"/en/api-reference/openapi_service.json post /datasets","href":"/en/api-reference/knowledge-bases/create-an-empty-knowledge-base"},{"title":"List Knowledge Bases","deprecated":null,"version":null,"sidebarTitle":"List Knowledge Bases","openapi":"/en/api-reference/openapi_service.json get /datasets","href":"/en/api-reference/knowledge-bases/list-knowledge-bases"},{"title":"Get Knowledge Base","deprecated":null,"version":null,"sidebarTitle":"Get Knowledge Base","openapi":"/en/api-reference/openapi_service.json get /datasets/{dataset_id}","href":"/en/api-reference/knowledge-bases/get-knowledge-base"},{"title":"Update Knowledge Base","deprecated":null,"version":null,"sidebarTitle":"Update Knowledge Base","openapi":"/en/api-reference/openapi_service.json patch /datasets/{dataset_id}","href":"/en/api-reference/knowledge-bases/update-knowledge-base"},{"title":"Delete Knowledge Base","deprecated":null,"version":null,"sidebarTitle":"Delete Knowledge Base","openapi":"/en/api-reference/openapi_service.json delete /datasets/{dataset_id}","href":"/en/api-reference/knowledge-bases/delete-knowledge-base"},{"title":"Retrieve Chunks from a Knowledge Base / Test Retrieval","deprecated":null,"version":null,"sidebarTitle":"Retrieve Chunks from a Knowledge Base / Test Retrieval","openapi":"/en/api-reference/openapi_service.json post /datasets/{dataset_id}/retrieve","href":"/en/api-reference/knowledge-bases/retrieve-chunks-from-a-knowledge-base-test-retrieval"}]},{"group":"Documents","pages":[{"title":"Create Document by Text","deprecated":null,"version":null,"sidebarTitle":"Create Document by Text","openapi":"/en/api-reference/openapi_service.json post /datasets/{dataset_id}/document/create-by-text","href":"/en/api-reference/documents/create-document-by-text"},{"title":"Create Document by File","deprecated":null,"version":null,"sidebarTitle":"Create Document by File","openapi":"/en/api-reference/openapi_service.json post /datasets/{dataset_id}/document/create-by-file","href":"/en/api-reference/documents/create-document-by-file"},{"title":"List Documents","deprecated":null,"version":null,"sidebarTitle":"List Documents","openapi":"/en/api-reference/openapi_service.json get /datasets/{dataset_id}/documents","href":"/en/api-reference/documents/list-documents"},{"title":"Get Document","deprecated":null,"version":null,"sidebarTitle":"Get Document","openapi":"/en/api-reference/openapi_service.json get /datasets/{dataset_id}/documents/{document_id}","href":"/en/api-reference/documents/get-document"},{"title":"Delete Document","deprecated":null,"version":null,"sidebarTitle":"Delete Document","openapi":"/en/api-reference/openapi_service.json delete /datasets/{dataset_id}/documents/{document_id}","href":"/en/api-reference/documents/delete-document"},{"title":"Update Document","deprecated":null,"version":null,"sidebarTitle":"Update Document","openapi":"/en/api-reference/openapi_service.json patch /datasets/{dataset_id}/documents/{document_id}","href":"/en/api-reference/documents/update-document"},{"title":"Download Document","deprecated":null,"version":null,"sidebarTitle":"Download Document","openapi":"/en/api-reference/openapi_service.json get /datasets/{dataset_id}/documents/{document_id}/download","href":"/en/api-reference/documents/download-document"},{"title":"Get Document Indexing Status","deprecated":null,"version":null,"sidebarTitle":"Get Document Indexing Status","openapi":"/en/api-reference/openapi_service.json get /datasets/{dataset_id}/documents/{batch}/indexing-status","href":"/en/api-reference/documents/get-document-indexing-status"},{"title":"Update Document by Text","deprecated":null,"version":null,"sidebarTitle":"Update Document by Text","openapi":"/en/api-reference/openapi_service.json post /datasets/{dataset_id}/documents/{document_id}/update-by-text","href":"/en/api-reference/documents/update-document-by-text"},{"title":"Update Document by File","deprecated":true,"version":null,"sidebarTitle":"Update Document by File","openapi":"/en/api-reference/openapi_service.json post /datasets/{dataset_id}/documents/{document_id}/update-by-file","href":"/en/api-reference/documents/update-document-by-file"},{"title":"Download Documents as ZIP","deprecated":null,"version":null,"sidebarTitle":"Download Documents as ZIP","openapi":"/en/api-reference/openapi_service.json post /datasets/{dataset_id}/documents/download-zip","href":"/en/api-reference/documents/download-documents-as-zip"},{"title":"Update Document Status in Batch","deprecated":null,"version":null,"sidebarTitle":"Update Document Status in Batch","openapi":"/en/api-reference/openapi_service.json patch /datasets/{dataset_id}/documents/status/{action}","href":"/en/api-reference/documents/update-document-status-in-batch"}]},{"group":"Chunks","pages":[{"title":"Create Chunks","deprecated":null,"version":null,"sidebarTitle":"Create Chunks","openapi":"/en/api-reference/openapi_service.json post /datasets/{dataset_id}/documents/{document_id}/segments","href":"/en/api-reference/chunks/create-chunks"},{"title":"List Chunks","deprecated":null,"version":null,"sidebarTitle":"List Chunks","openapi":"/en/api-reference/openapi_service.json get /datasets/{dataset_id}/documents/{document_id}/segments","href":"/en/api-reference/chunks/list-chunks"},{"title":"Get Chunk","deprecated":null,"version":null,"sidebarTitle":"Get Chunk","openapi":"/en/api-reference/openapi_service.json get /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}","href":"/en/api-reference/chunks/get-chunk"},{"title":"Update Chunk","deprecated":null,"version":null,"sidebarTitle":"Update Chunk","openapi":"/en/api-reference/openapi_service.json post /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}","href":"/en/api-reference/chunks/update-chunk"},{"title":"Delete Chunk","deprecated":null,"version":null,"sidebarTitle":"Delete Chunk","openapi":"/en/api-reference/openapi_service.json delete /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}","href":"/en/api-reference/chunks/delete-chunk"},{"title":"Create Child Chunk","deprecated":null,"version":null,"sidebarTitle":"Create Child Chunk","openapi":"/en/api-reference/openapi_service.json post /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks","href":"/en/api-reference/chunks/create-child-chunk"},{"title":"List Child Chunks","deprecated":null,"version":null,"sidebarTitle":"List Child Chunks","openapi":"/en/api-reference/openapi_service.json get /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks","href":"/en/api-reference/chunks/list-child-chunks"},{"title":"Update Child Chunk","deprecated":null,"version":null,"sidebarTitle":"Update Child Chunk","openapi":"/en/api-reference/openapi_service.json patch /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks/{child_chunk_id}","href":"/en/api-reference/chunks/update-child-chunk"},{"title":"Delete Child Chunk","deprecated":null,"version":null,"sidebarTitle":"Delete Child Chunk","openapi":"/en/api-reference/openapi_service.json delete /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks/{child_chunk_id}","href":"/en/api-reference/chunks/delete-child-chunk"}]},{"group":"Metadata","pages":[{"title":"Create Metadata Field","deprecated":null,"version":null,"sidebarTitle":"Create Metadata Field","openapi":"/en/api-reference/openapi_service.json post /datasets/{dataset_id}/metadata","href":"/en/api-reference/metadata/create-metadata-field"},{"title":"List Metadata Fields","deprecated":null,"version":null,"sidebarTitle":"List Metadata Fields","openapi":"/en/api-reference/openapi_service.json get /datasets/{dataset_id}/metadata","href":"/en/api-reference/metadata/list-metadata-fields"},{"title":"Update Metadata Field","deprecated":null,"version":null,"sidebarTitle":"Update Metadata Field","openapi":"/en/api-reference/openapi_service.json patch /datasets/{dataset_id}/metadata/{metadata_id}","href":"/en/api-reference/metadata/update-metadata-field"},{"title":"Delete Metadata Field","deprecated":null,"version":null,"sidebarTitle":"Delete Metadata Field","openapi":"/en/api-reference/openapi_service.json delete /datasets/{dataset_id}/metadata/{metadata_id}","href":"/en/api-reference/metadata/delete-metadata-field"},{"title":"Get Built-in Metadata Fields","deprecated":null,"version":null,"sidebarTitle":"Get Built-in Metadata Fields","openapi":"/en/api-reference/openapi_service.json get /datasets/{dataset_id}/metadata/built-in","href":"/en/api-reference/metadata/get-built-in-metadata-fields"},{"title":"Update Built-in Metadata Field","deprecated":null,"version":null,"sidebarTitle":"Update Built-in Metadata Field","openapi":"/en/api-reference/openapi_service.json post /datasets/{dataset_id}/metadata/built-in/{action}","href":"/en/api-reference/metadata/update-built-in-metadata-field"},{"title":"Update Document Metadata in Batch","deprecated":null,"version":null,"sidebarTitle":"Update Document Metadata in Batch","openapi":"/en/api-reference/openapi_service.json post /datasets/{dataset_id}/documents/metadata","href":"/en/api-reference/metadata/update-document-metadata-in-batch"}]},{"group":"Tags","pages":[{"title":"Create Knowledge Tag","deprecated":null,"version":null,"sidebarTitle":"Create Knowledge Tag","openapi":"/en/api-reference/openapi_service.json post /datasets/tags","href":"/en/api-reference/tags/create-knowledge-tag"},{"title":"List Knowledge Tags","deprecated":null,"version":null,"sidebarTitle":"List Knowledge Tags","openapi":"/en/api-reference/openapi_service.json get /datasets/tags","href":"/en/api-reference/tags/list-knowledge-tags"},{"title":"Update Knowledge Tag","deprecated":null,"version":null,"sidebarTitle":"Update Knowledge Tag","openapi":"/en/api-reference/openapi_service.json patch /datasets/tags","href":"/en/api-reference/tags/update-knowledge-tag"},{"title":"Delete Knowledge Tag","deprecated":null,"version":null,"sidebarTitle":"Delete Knowledge Tag","openapi":"/en/api-reference/openapi_service.json delete /datasets/tags","href":"/en/api-reference/tags/delete-knowledge-tag"},{"title":"Create Tag Binding","deprecated":null,"version":null,"sidebarTitle":"Create Tag Binding","openapi":"/en/api-reference/openapi_service.json post /datasets/tags/binding","href":"/en/api-reference/tags/create-tag-binding"},{"title":"Delete Tag Binding","deprecated":null,"version":null,"sidebarTitle":"Delete Tag Binding","openapi":"/en/api-reference/openapi_service.json post /datasets/tags/unbinding","href":"/en/api-reference/tags/delete-tag-binding"},{"title":"Get Knowledge Base Tags","deprecated":null,"version":null,"sidebarTitle":"Get Knowledge Base Tags","openapi":"/en/api-reference/openapi_service.json get /datasets/{dataset_id}/tags","href":"/en/api-reference/tags/get-knowledge-base-tags"}]},{"group":"Models","pages":[{"title":"Get Available Models","deprecated":null,"version":null,"sidebarTitle":"Get Available Models","openapi":"/en/api-reference/openapi_service.json get /workspaces/current/models/model-types/{model_type}","href":"/en/api-reference/models/get-available-models"}]},{"group":"Knowledge Pipeline","pages":[{"title":"Upload Pipeline File","deprecated":null,"version":null,"sidebarTitle":"Upload Pipeline File","openapi":"/en/api-reference/openapi_service.json post /datasets/pipeline/file-upload","href":"/en/api-reference/knowledge-pipeline/upload-pipeline-file"},{"title":"List Datasource Plugins","deprecated":null,"version":null,"sidebarTitle":"List Datasource Plugins","openapi":"/en/api-reference/openapi_service.json get /datasets/{dataset_id}/pipeline/datasource-plugins","href":"/en/api-reference/knowledge-pipeline/list-datasource-plugins"},{"title":"Run Datasource Node","deprecated":null,"version":null,"sidebarTitle":"Run Datasource Node","openapi":"/en/api-reference/openapi_service.json post /datasets/{dataset_id}/pipeline/datasource/nodes/{node_id}/run","href":"/en/api-reference/knowledge-pipeline/run-datasource-node"},{"title":"Run Pipeline","deprecated":null,"version":null,"sidebarTitle":"Run Pipeline","openapi":"/en/api-reference/openapi_service.json post /datasets/{dataset_id}/pipeline/run","href":"/en/api-reference/knowledge-pipeline/run-pipeline"}]}]}]},{"item":"CLI","icon":"terminal","groups":[{"group":" ","expanded":true,"pages":[{"title":"Overview","href":"/en/cloud/cli/overview"},{"title":"Install difyctl","sidebarTitle":"Install","href":"/en/cloud/cli/install"},{"title":"Quick Start","href":"/en/cloud/cli/quick-start"},{"title":"Authenticate","href":"/en/cloud/cli/authenticate"},{"title":"Common Tasks","href":"/en/cloud/cli/common-tasks"},{"group":"Integrate Your Agents","pages":[{"title":"Integrate Your Agents with Dify Apps","sidebarTitle":"Overview","href":"/en/cloud/cli/integrate-agents/overview"},{"title":"Authenticate Where Your Agent Runs","sidebarTitle":"Authenticate","href":"/en/cloud/cli/integrate-agents/auth-for-agent-deployments"},{"title":"Install the difyctl Skill","href":"/en/cloud/cli/integrate-agents/install-the-difyctl-skill"},{"title":"Handle Errors and Retries","href":"/en/cloud/cli/integrate-agents/error-handling-and-retries-for-agents"}]},{"group":"CLI Reference","pages":[{"title":"Command Index","href":"/en/cloud/cli/reference/command-index"},{"title":"Global Flags","href":"/en/cloud/cli/reference/global-flags"},{"title":"Output Formats and Exit Codes","href":"/en/cloud/cli/reference/output-formats-and-exit-codes"},{"title":"Environment Variables","href":"/en/cloud/cli/reference/environment-variables"},{"group":"Commands","expanded":true,"pages":[{"title":"Apps","href":"/en/cloud/cli/reference/apps"},{"title":"Auth and Contexts","href":"/en/cloud/cli/reference/auth-and-contexts"},{"title":"Workspaces","href":"/en/cloud/cli/reference/workspaces"},{"title":"Help","href":"/en/cloud/cli/reference/help"},{"title":"Skills","href":"/en/cloud/cli/reference/skills"},{"title":"Version","href":"/en/cloud/cli/reference/version"}]}]},{"title":"Troubleshooting","href":"/en/cloud/cli/troubleshooting"}]}]},{"item":"Plugins","icon":"code-pull-request","groups":[{"group":"Getting Started","icon":"rocket","pages":[{"title":"Dify Plugin","href":"/en/develop-plugin/getting-started/getting-started-dify-plugin"},{"title":"Choose a Plugin Type","href":"/en/develop-plugin/getting-started/choose-plugin-type"},{"title":"Dify Plugin CLI","href":"/en/develop-plugin/getting-started/cli"}]},{"group":"Features \u0026 Specs","icon":"list-check","pages":[{"group":"Plugin Types","pages":[{"title":"General Specs","href":"/en/develop-plugin/features-and-specs/plugin-types/general-specifications"},{"title":"Model Specs","href":"/en/develop-plugin/features-and-specs/plugin-types/model-designing-rules"},{"title":"Model API Interface","href":"/en/develop-plugin/features-and-specs/plugin-types/model-schema"},{"title":"Persistent Storage","href":"/en/develop-plugin/features-and-specs/plugin-types/persistent-storage-kv"},{"title":"Tool Return","href":"/en/develop-plugin/features-and-specs/plugin-types/tool"},{"title":"Manifest","href":"/en/develop-plugin/features-and-specs/plugin-types/plugin-info-by-manifest"},{"title":"Multilingual README","href":"/en/develop-plugin/features-and-specs/plugin-types/multilingual-readme"},{"title":"Plugin Debugging","href":"/en/develop-plugin/features-and-specs/plugin-types/remote-debug-a-plugin"},{"title":"Plugin Logging","href":"/en/develop-plugin/features-and-specs/plugin-types/plugin-logging"}]},{"group":"Advanced Development","pages":[{"group":"Reverse Calling","pages":[{"title":"Bundle Plugin Package","href":"/en/develop-plugin/features-and-specs/advanced-development/bundle"},{"title":"Reverse Invocation of Dify Services","href":"/en/develop-plugin/features-and-specs/advanced-development/reverse-invocation"},{"title":"App","href":"/en/develop-plugin/features-and-specs/advanced-development/reverse-invocation-app"},{"title":"Reverse Invocation Model","href":"/en/develop-plugin/features-and-specs/advanced-development/reverse-invocation-model"},{"title":"Tool","href":"/en/develop-plugin/features-and-specs/advanced-development/reverse-invocation-tool"},{"title":"Integrate Custom Models","href":"/en/develop-plugin/features-and-specs/advanced-development/customizable-model"},{"title":"Node","href":"/en/develop-plugin/features-and-specs/advanced-development/reverse-invocation-node"}]}]}]},{"group":"Development Guides \u0026 Walkthroughs","icon":"code","pages":[{"title":"Cheatsheet","href":"/en/develop-plugin/dev-guides-and-walkthroughs/cheatsheet"},{"group":"By Plugin Type","pages":[{"title":"Tool Plugin","href":"/en/develop-plugin/dev-guides-and-walkthroughs/tool-plugin"},{"title":"Tool OAuth","href":"/en/develop-plugin/dev-guides-and-walkthroughs/tool-oauth"},{"title":"Model Provider Plugin","href":"/en/develop-plugin/dev-guides-and-walkthroughs/creating-new-model-provider"},{"title":"Agent Strategy Plugin","href":"/en/develop-plugin/dev-guides-and-walkthroughs/agent-strategy-plugin"},{"title":"Data Source Plugin","href":"/en/develop-plugin/dev-guides-and-walkthroughs/datasource-plugin"},{"title":"Trigger Plugin","href":"/en/develop-plugin/dev-guides-and-walkthroughs/trigger-plugin"},{"title":"Endpoint Plugin","href":"/en/develop-plugin/dev-guides-and-walkthroughs/endpoint"}]},{"group":"Full Walkthroughs","pages":[{"title":"Flomo Tool (10-min)","href":"/en/develop-plugin/dev-guides-and-walkthroughs/develop-flomo-plugin"},{"title":"Slack Bot","href":"/en/develop-plugin/dev-guides-and-walkthroughs/develop-a-slack-bot-plugin"},{"title":"Markdown Exporter","href":"/en/develop-plugin/dev-guides-and-walkthroughs/develop-md-exporter"},{"title":"Multimodal Tool","href":"/en/develop-plugin/dev-guides-and-walkthroughs/develop-multimodal-data-processing-tool"}]}]},{"group":"Publishing","icon":"upload","pages":[{"title":"Publish Plugins","href":"/en/develop-plugin/publishing/marketplace-listing/release-overview"},{"group":"Standards","pages":[{"title":"Plugin Development Guidelines","href":"/en/develop-plugin/publishing/standards/contributor-covenant-code-of-conduct"},{"title":"Privacy Guidelines","href":"/en/develop-plugin/publishing/standards/privacy-protection-guidelines"}]},{"title":"Publish a Plugin to Marketplace","sidebarTitle":"Marketplace","href":"/en/develop-plugin/publishing/marketplace-listing/submit-plugin-to-marketplace"},{"group":"GitHub Repository","pages":[{"title":"Publish to Individual GitHub Repository","href":"/en/develop-plugin/publishing/marketplace-listing/release-to-individual-github-repo"}]},{"group":"Local File","pages":[{"title":"Package as Local File and Share","href":"/en/develop-plugin/publishing/marketplace-listing/release-by-file"},{"title":"Sign Plugins for Third-Party Signature Verification","href":"/en/develop-plugin/publishing/standards/third-party-signature-verification"}]},{"title":"Frequently Asked Questions","sidebarTitle":"FAQ","href":"/en/develop-plugin/publishing/faq/faq"}]}]}]}]},{"product":"Self-Host","icon":"server","tabs":[{"tab":"Deploy","icon":"server","pages":[{"title":"Deploy Dify","sidebarTitle":"Overview","mode":"frame","href":"/en/self-host/deploy/overview"},{"group":"Quick Start","icon":"rocket","pages":[{"title":"Deploy Dify with Docker Compose","sidebarTitle":"Docker Compose","href":"/en/self-host/deploy/quick-start/docker-compose"},{"title":"FAQs","href":"/en/self-host/deploy/quick-start/faqs"}]},{"group":"Advanced Deployments","icon":"server","pages":[{"title":"Local Source Code Start","href":"/en/self-host/deploy/advanced-deployments/local-source-code"},{"title":"Start Frontend Docker Container Separately","href":"/en/self-host/deploy/advanced-deployments/start-the-frontend-docker-container"}]},{"group":"Configuration","icon":"gear","pages":[{"title":"Environment Variables","href":"/en/self-host/deploy/configuration/environments"}]},{"group":"Platform Guides","icon":"map","pages":[{"title":"Deploy with aaPanel","href":"/en/self-host/deploy/platform-guides/bt-panel"},{"title":"Dify Premium on AWS","href":"/en/self-host/deploy/platform-guides/dify-premium"}]},{"group":"Troubleshooting","icon":"wrench","pages":[{"title":"Common Issues","href":"/en/self-host/deploy/troubleshooting/common-issues"},{"title":"Docker Issues","href":"/en/self-host/deploy/troubleshooting/docker-issues"},{"title":"Third-Party Integrations","href":"/en/self-host/deploy/troubleshooting/integrations"},{"title":"Storage \u0026 Migration","href":"/en/self-host/deploy/troubleshooting/storage-and-migration"},{"title":"Weaviate Migration Guide upgrading to Client v4 and Server 1.27+","href":"/en/self-host/deploy/troubleshooting/weaviate-v4-migration"},{"title":"Weaviate Server Upgrade Path","href":"/en/self-host/deploy/troubleshooting/weaviate-server-migration-path"}]}]},{"tab":"Use","icon":"book-open","pages":[{"title":"Use Dify","sidebarTitle":"Overview","mode":"frame","href":"/en/self-host/use-dify/getting-started/introduction"},{"group":"Orchestrate","icon":"hammer","pages":[{"group":"Workflow \u0026 Chatflow","expanded":false,"pages":[{"title":"Workflow \u0026 Chatflow","sidebarTitle":"Overview","href":"/en/self-host/use-dify/build/workflow-chatflow"},{"title":"Orchestration Logic","href":"/en/self-host/use-dify/build/orchestrate-node"},{"group":"Nodes","expanded":false,"pages":[{"group":"Start","root":{"title":"Start Node","href":"/en/self-host/use-dify/nodes/start"},"pages":[{"title":"User Input","href":"/en/self-host/use-dify/nodes/user-input"},{"group":"Trigger","root":{"title":"Trigger","sidebarTitle":"Overview","href":"/en/self-host/use-dify/nodes/trigger/overview"},"pages":[{"title":"Schedule Trigger","href":"/en/self-host/use-dify/nodes/trigger/schedule-trigger"},{"title":"Integration Trigger","href":"/en/self-host/use-dify/nodes/trigger/plugin-trigger"},{"title":"Webhook Trigger","href":"/en/self-host/use-dify/nodes/trigger/webhook-trigger"}]}]},{"title":"LLM","href":"/en/self-host/use-dify/nodes/llm"},{"title":"Knowledge Retrieval","href":"/en/self-host/use-dify/nodes/knowledge-retrieval"},{"title":"Answer","href":"/en/self-host/use-dify/nodes/answer"},{"title":"Output","href":"/en/self-host/use-dify/nodes/output"},{"title":"Agent","href":"/en/self-host/use-dify/nodes/agent"},{"title":"Question Classifier","href":"/en/self-host/use-dify/nodes/question-classifier"},{"title":"If-Else","href":"/en/self-host/use-dify/nodes/ifelse"},{"group":"Human Input","root":{"title":"Human Input","href":"/en/self-host/use-dify/nodes/human-input"},"expanded":false,"pages":[]},{"title":"Iteration","href":"/en/self-host/use-dify/nodes/iteration"},{"title":"Loop","href":"/en/self-host/use-dify/nodes/loop"},{"title":"Code","href":"/en/self-host/use-dify/nodes/code"},{"title":"Template","href":"/en/self-host/use-dify/nodes/template"},{"title":"Variable Aggregator","href":"/en/self-host/use-dify/nodes/variable-aggregator"},{"title":"Document Extractor","href":"/en/self-host/use-dify/nodes/doc-extractor"},{"title":"Variable Assigner","href":"/en/self-host/use-dify/nodes/variable-assigner"},{"title":"Parameter Extractor","href":"/en/self-host/use-dify/nodes/parameter-extractor"},{"title":"HTTP Request","href":"/en/self-host/use-dify/nodes/http-request"},{"title":"List Operator","href":"/en/self-host/use-dify/nodes/list-operator"},{"title":"Tool Node","sidebarTitle":"Tool","href":"/en/self-host/use-dify/nodes/tools"}]},{"title":"Hotkeys","href":"/en/self-host/use-dify/build/shortcut-key"},{"title":"Version Control","href":"/en/self-host/use-dify/build/version-control"},{"title":"Snippets","sidebarTitle":"Snippets","href":"/en/self-host/use-dify/build/snippet"},{"title":"Collaborate with Teammates","sidebarTitle":"Collaboration","href":"/en/self-host/use-dify/build/workflow-collaboration"},{"group":"Debug","expanded":false,"pages":[{"title":"Handle Errors","href":"/en/self-host/use-dify/build/predefined-error-handling-logic"},{"title":"Single Node","href":"/en/self-host/use-dify/debug/step-run"},{"title":"Variable Inspector","href":"/en/self-host/use-dify/debug/variable-inspect"},{"title":"Run History","href":"/en/self-host/use-dify/debug/history-and-logs"},{"title":"Error Types","href":"/en/self-host/use-dify/debug/error-type"}]}]},{"group":"Agent","tag":"New","expanded":false,"pages":[{"title":"Agent","sidebarTitle":"Overview","href":"/en/self-host/use-dify/build/new-agent/overview"},{"title":"Build an Agent","sidebarTitle":"Build","href":"/en/self-host/use-dify/build/new-agent/build"}]},{"title":"Skills","sidebarTitle":"Skills","href":"/en/self-host/use-dify/build/skills"},{"group":"Basic Apps","expanded":false,"pages":[{"title":"Agent","tag":"Legacy","href":"/en/self-host/use-dify/build/agent"},{"title":"Chatbot","sidebarTitle":"Chatbot","href":"/en/self-host/use-dify/build/chatbot"},{"title":"Text Generator","sidebarTitle":"Text Generator","href":"/en/self-host/use-dify/build/text-generator"}]},{"title":"App Toolkit","href":"/en/self-host/use-dify/build/additional-features"},{"title":"Go to Anything","href":"/en/self-host/use-dify/build/goto-anything"}]},{"group":"Publish","icon":"paper-plane","expanded":false,"pages":[{"title":"Overview","href":"/en/self-host/use-dify/publish/README"},{"group":"Web App","pages":[{"title":"Workflow Web Apps","href":"/en/self-host/use-dify/publish/webapp/workflow-webapp"},{"title":"Chat Web Apps","href":"/en/self-host/use-dify/publish/webapp/chatflow-webapp"},{"title":"Settings","href":"/en/self-host/use-dify/publish/webapp/web-app-settings"},{"title":"Embed Your Web App","sidebarTitle":"Embeds","href":"/en/self-host/use-dify/publish/webapp/embedding-in-websites"}]},{"title":"MCP Server","href":"/en/self-host/use-dify/publish/publish-mcp"},{"title":"Publish Apps to Marketplace","sidebarTitle":"Marketplace","href":"/en/self-host/use-dify/publish/publish-to-marketplace"}]},{"group":"Monitor","icon":"chart-line","expanded":false,"pages":[{"title":"Dashboard","href":"/en/self-host/use-dify/monitor/analysis"},{"title":"Logs","href":"/en/self-host/use-dify/monitor/logs"},{"title":"Annotation System","href":"/en/self-host/use-dify/monitor/annotation-reply"},{"group":"Integrations","pages":[{"title":"Integrate with LangSmith","sidebarTitle":"LangSmith","href":"/en/self-host/use-dify/monitor/integrations/integrate-langsmith"},{"title":"Integrate with Langfuse","sidebarTitle":"Langfuse","href":"/en/self-host/use-dify/monitor/integrations/integrate-langfuse"},{"title":"Integrate with Opik","sidebarTitle":"Opik","href":"/en/self-host/use-dify/monitor/integrations/integrate-opik"},{"title":"Integrate with W\u0026B Weave","sidebarTitle":"W\u0026B Weave","href":"/en/self-host/use-dify/monitor/integrations/integrate-weave"},{"title":"Integrate with Arize","sidebarTitle":"Arize","href":"/en/self-host/use-dify/monitor/integrations/integrate-arize"},{"title":"Integrate with Phoenix","sidebarTitle":"Phoenix","href":"/en/self-host/use-dify/monitor/integrations/integrate-phoenix"},{"title":"Integrate with Alibaba Cloud Monitor","sidebarTitle":"Alibaba Cloud Monitor","href":"/en/self-host/use-dify/monitor/integrations/integrate-aliyun"}]}]},{"group":"Knowledge","icon":"book","expanded":false,"pages":[{"title":"Knowledge","sidebarTitle":"Overview","href":"/en/self-host/use-dify/knowledge/readme"},{"group":"Create","pages":[{"group":"Ready-to-Use Knowledge Base","pages":[{"title":"Create a Ready-to-Use Knowledge Base","sidebarTitle":"Overview","href":"/en/self-host/use-dify/knowledge/create-knowledge/introduction"},{"group":"Import Data","pages":[{"title":"Upload Local Files","href":"/en/self-host/use-dify/knowledge/create-knowledge/import-text-data/readme"},{"title":"Sync Data from Notion","href":"/en/self-host/use-dify/knowledge/create-knowledge/import-text-data/sync-from-notion"},{"title":"Import Data from Website","href":"/en/self-host/use-dify/knowledge/create-knowledge/import-text-data/sync-from-website"}]},{"title":"Configure the Chunk Settings","href":"/en/self-host/use-dify/knowledge/create-knowledge/chunking-and-cleaning-text"},{"title":"Specify the Index Method and Retrieval Settings","href":"/en/self-host/use-dify/knowledge/create-knowledge/setting-indexing-methods"}]},{"group":"Custom Knowledge Base","pages":[{"title":"Build a Custom Knowledge Base","sidebarTitle":"Overview","href":"/en/self-host/use-dify/knowledge/knowledge-pipeline/readme"},{"title":"Step 1: Create Knowledge Pipeline","href":"/en/self-host/use-dify/knowledge/knowledge-pipeline/create-knowledge-pipeline"},{"title":"Step 2: Orchestrate Knowledge Pipeline","href":"/en/self-host/use-dify/knowledge/knowledge-pipeline/knowledge-pipeline-orchestration"},{"title":"Step 3: Publish Knowledge Pipeline","href":"/en/self-host/use-dify/knowledge/knowledge-pipeline/publish-knowledge-pipeline"},{"title":"Step 4: Upload Files","href":"/en/self-host/use-dify/knowledge/knowledge-pipeline/upload-files"},{"title":"Step 5: Manage and Use Knowledge Base","href":"/en/self-host/use-dify/knowledge/knowledge-pipeline/manage-knowledge-base"},{"title":"Authorize Data Source","href":"/en/self-host/use-dify/knowledge/knowledge-pipeline/authorize-data-source"}]},{"group":"Connect to External Knowledge","pages":[{"title":"Connect to External Knowledge Base","sidebarTitle":"Overview","href":"/en/self-host/use-dify/knowledge/connect-external-knowledge-base"},{"title":"External Knowledge API","href":"/en/self-host/use-dify/knowledge/external-knowledge-api"}]}]},{"group":"Manage","pages":[{"title":"Manage Knowledge Content","sidebarTitle":"Documents \u0026 Chunks","href":"/en/self-host/use-dify/knowledge/manage-knowledge/maintain-knowledge-documents"},{"title":"Manage Document Metadata","sidebarTitle":"Metadata","href":"/en/self-host/use-dify/knowledge/metadata"},{"title":"Manage Knowledge Settings","sidebarTitle":"Settings","href":"/en/self-host/use-dify/knowledge/manage-knowledge/introduction"}]},{"title":"Test Knowledge Retrieval","sidebarTitle":"Test Retrieval","href":"/en/self-host/use-dify/knowledge/test-retrieval"},{"title":"Integrate Knowledge within Apps","sidebarTitle":"Integrate in Apps","href":"/en/self-host/use-dify/knowledge/integrate-knowledge-within-application"}]},{"group":"Integrations","icon":"plug","expanded":false,"pages":[{"title":"Integrations","sidebarTitle":"Overview","href":"/en/self-host/use-dify/workspace/plugins"},{"title":"Model Providers","href":"/en/self-host/use-dify/workspace/model-providers"},{"title":"Dify Tools","sidebarTitle":"Tools","href":"/en/self-host/use-dify/workspace/tools"},{"group":"Custom Endpoint","pages":[{"title":"Custom Endpoints","sidebarTitle":"Overview","href":"/en/self-host/use-dify/workspace/api-extension/api-extension"},{"title":"External Data Tool","href":"/en/self-host/use-dify/workspace/api-extension/external-data-tool-api-extension"},{"title":"Sensitive Content Moderation","href":"/en/self-host/use-dify/workspace/api-extension/moderation-api-extension"},{"title":"Deploy Custom Endpoints Using Cloudflare Workers","href":"/en/self-host/use-dify/workspace/api-extension/cloudflare-worker"}]}]},{"group":"Workspace","icon":"briefcase","expanded":false,"pages":[{"title":"Overview","href":"/en/self-host/use-dify/workspace/readme"},{"title":"Export and Import Apps","sidebarTitle":"Export and Import","href":"/en/self-host/use-dify/workspace/export-import-apps"},{"title":"Manage Members","href":"/en/self-host/use-dify/workspace/team-members-management"},{"title":"Personal Settings","href":"/en/self-host/use-dify/workspace/personal-account-management"}]}]},{"tab":"Learn","icon":"graduation-cap","pages":[{"title":"Key Concepts","href":"/en/learn/key-concepts"},{"group":"Tutorials","pages":[{"title":"30-Minute Quick Start","href":"/en/quick-start"},{"group":"Workflow 101","pages":[{"title":"Lesson 1: What is a Workflow?","href":"/en/learn/tutorials/workflow-101/lesson-01"},{"title":"Lesson 2: Head and Tail (Start \u0026 Output Node)","sidebarTitle":"Lesson 2: Head and Tail","href":"/en/learn/tutorials/workflow-101/lesson-02"},{"title":"Lesson 3: The Brain of the Workflow (LLM Node)","sidebarTitle":"Lesson 3: The Brain of the Workflow","href":"/en/learn/tutorials/workflow-101/lesson-03"},{"title":"Lesson 4: The Cheat Sheet (Knowledge Retrieval)","sidebarTitle":"Lesson 4: The Cheat Sheet","href":"/en/learn/tutorials/workflow-101/lesson-04"},{"title":"Lesson 5: The Crossroads of Your Workflow (Sorting and Executing)","sidebarTitle":"Lesson 5: The Crossroads of Your Workflow","href":"/en/learn/tutorials/workflow-101/lesson-05"},{"title":"Lesson 6: Handle Multiple Tasks (Parameter Extraction \u0026 Iteration)","sidebarTitle":"Lesson 6: Handle Multiple Tasks","href":"/en/learn/tutorials/workflow-101/lesson-06"},{"title":"Lesson 7: Enhance Workflows (Tools)","sidebarTitle":"Lesson 7: Enhance Workflows","href":"/en/learn/tutorials/workflow-101/lesson-07"},{"title":"Lesson 8: The Agent Node","sidebarTitle":"Lesson 8: The Agent Node","href":"/en/learn/tutorials/workflow-101/lesson-08"},{"title":"Lesson 9: Layout Designer (Template)","sidebarTitle":"Lesson 9: Layout Designer","href":"/en/learn/tutorials/workflow-101/lesson-09"},{"title":"Lesson 10: Publish and Monitor Your AI App","sidebarTitle":"Lesson 10: Publish and Monitor","href":"/en/learn/tutorials/workflow-101/lesson-10"}]},{"title":"Simple Chatbot","href":"/en/learn/tutorials/simple-chatbot"},{"title":"Twitter Account Analyzer","href":"/en/learn/tutorials/twitter-chatflow"},{"title":"Customer Service Bot With Knowledge Base","href":"/en/learn/tutorials/customer-service-bot"},{"title":"AI Image Generation App","href":"/en/learn/tutorials/build-ai-image-generation-app"},{"title":"Article Reader Using File Upload","href":"/en/learn/tutorials/article-reader"}]}]},{"tab":"Developer Resources","icon":"code","menu":[{"item":"API","icon":"code","groups":[{"group":"Guides","pages":[{"title":"Get Started with the Dify API","sidebarTitle":"Get Started","href":"/en/api-reference/guides/get-started"},{"group":"API Overviews","expanded":true,"pages":[{"title":"Chatflow App API","sidebarTitle":"Chatflow","href":"/en/api-reference/guides/chatflow"},{"title":"Workflow App API","sidebarTitle":"Workflow","href":"/en/api-reference/guides/workflow"},{"title":"Agent API","sidebarTitle":"Agent","tag":"New","href":"/en/api-reference/guides/agent"},{"title":"Knowledge API","sidebarTitle":"Knowledge","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":"Knowledge Bases","pages":[{"title":"Create an Empty Knowledge Base","deprecated":null,"version":null,"sidebarTitle":"Create an Empty Knowledge Base","openapi":"/en/api-reference/openapi_service.json post /datasets","href":"/en/api-reference/knowledge-bases/create-an-empty-knowledge-base"},{"title":"List Knowledge Bases","deprecated":null,"version":null,"sidebarTitle":"List Knowledge Bases","openapi":"/en/api-reference/openapi_service.json get /datasets","href":"/en/api-reference/knowledge-bases/list-knowledge-bases"},{"title":"Get Knowledge Base","deprecated":null,"version":null,"sidebarTitle":"Get Knowledge Base","openapi":"/en/api-reference/openapi_service.json get /datasets/{dataset_id}","href":"/en/api-reference/knowledge-bases/get-knowledge-base"},{"title":"Update Knowledge Base","deprecated":null,"version":null,"sidebarTitle":"Update Knowledge Base","openapi":"/en/api-reference/openapi_service.json patch /datasets/{dataset_id}","href":"/en/api-reference/knowledge-bases/update-knowledge-base"},{"title":"Delete Knowledge Base","deprecated":null,"version":null,"sidebarTitle":"Delete Knowledge Base","openapi":"/en/api-reference/openapi_service.json delete /datasets/{dataset_id}","href":"/en/api-reference/knowledge-bases/delete-knowledge-base"},{"title":"Retrieve Chunks from a Knowledge Base / Test Retrieval","deprecated":null,"version":null,"sidebarTitle":"Retrieve Chunks from a Knowledge Base / Test Retrieval","openapi":"/en/api-reference/openapi_service.json post /datasets/{dataset_id}/retrieve","href":"/en/api-reference/knowledge-bases/retrieve-chunks-from-a-knowledge-base-test-retrieval"}]},{"group":"Documents","pages":[{"title":"Create Document by Text","deprecated":null,"version":null,"sidebarTitle":"Create Document by Text","openapi":"/en/api-reference/openapi_service.json post /datasets/{dataset_id}/document/create-by-text","href":"/en/api-reference/documents/create-document-by-text"},{"title":"Create Document by File","deprecated":null,"version":null,"sidebarTitle":"Create Document by File","openapi":"/en/api-reference/openapi_service.json post /datasets/{dataset_id}/document/create-by-file","href":"/en/api-reference/documents/create-document-by-file"},{"title":"List Documents","deprecated":null,"version":null,"sidebarTitle":"List Documents","openapi":"/en/api-reference/openapi_service.json get /datasets/{dataset_id}/documents","href":"/en/api-reference/documents/list-documents"},{"title":"Get Document","deprecated":null,"version":null,"sidebarTitle":"Get Document","openapi":"/en/api-reference/openapi_service.json get /datasets/{dataset_id}/documents/{document_id}","href":"/en/api-reference/documents/get-document"},{"title":"Delete Document","deprecated":null,"version":null,"sidebarTitle":"Delete Document","openapi":"/en/api-reference/openapi_service.json delete /datasets/{dataset_id}/documents/{document_id}","href":"/en/api-reference/documents/delete-document"},{"title":"Update Document","deprecated":null,"version":null,"sidebarTitle":"Update Document","openapi":"/en/api-reference/openapi_service.json patch /datasets/{dataset_id}/documents/{document_id}","href":"/en/api-reference/documents/update-document"},{"title":"Download Document","deprecated":null,"version":null,"sidebarTitle":"Download Document","openapi":"/en/api-reference/openapi_service.json get /datasets/{dataset_id}/documents/{document_id}/download","href":"/en/api-reference/documents/download-document"},{"title":"Get Document Indexing Status","deprecated":null,"version":null,"sidebarTitle":"Get Document Indexing Status","openapi":"/en/api-reference/openapi_service.json get /datasets/{dataset_id}/documents/{batch}/indexing-status","href":"/en/api-reference/documents/get-document-indexing-status"},{"title":"Update Document by Text","deprecated":null,"version":null,"sidebarTitle":"Update Document by Text","openapi":"/en/api-reference/openapi_service.json post /datasets/{dataset_id}/documents/{document_id}/update-by-text","href":"/en/api-reference/documents/update-document-by-text"},{"title":"Update Document by File","deprecated":true,"version":null,"sidebarTitle":"Update Document by File","openapi":"/en/api-reference/openapi_service.json post /datasets/{dataset_id}/documents/{document_id}/update-by-file","href":"/en/api-reference/documents/update-document-by-file"},{"title":"Download Documents as ZIP","deprecated":null,"version":null,"sidebarTitle":"Download Documents as ZIP","openapi":"/en/api-reference/openapi_service.json post /datasets/{dataset_id}/documents/download-zip","href":"/en/api-reference/documents/download-documents-as-zip"},{"title":"Update Document Status in Batch","deprecated":null,"version":null,"sidebarTitle":"Update Document Status in Batch","openapi":"/en/api-reference/openapi_service.json patch /datasets/{dataset_id}/documents/status/{action}","href":"/en/api-reference/documents/update-document-status-in-batch"}]},{"group":"Chunks","pages":[{"title":"Create Chunks","deprecated":null,"version":null,"sidebarTitle":"Create Chunks","openapi":"/en/api-reference/openapi_service.json post /datasets/{dataset_id}/documents/{document_id}/segments","href":"/en/api-reference/chunks/create-chunks"},{"title":"List Chunks","deprecated":null,"version":null,"sidebarTitle":"List Chunks","openapi":"/en/api-reference/openapi_service.json get /datasets/{dataset_id}/documents/{document_id}/segments","href":"/en/api-reference/chunks/list-chunks"},{"title":"Get Chunk","deprecated":null,"version":null,"sidebarTitle":"Get Chunk","openapi":"/en/api-reference/openapi_service.json get /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}","href":"/en/api-reference/chunks/get-chunk"},{"title":"Update Chunk","deprecated":null,"version":null,"sidebarTitle":"Update Chunk","openapi":"/en/api-reference/openapi_service.json post /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}","href":"/en/api-reference/chunks/update-chunk"},{"title":"Delete Chunk","deprecated":null,"version":null,"sidebarTitle":"Delete Chunk","openapi":"/en/api-reference/openapi_service.json delete /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}","href":"/en/api-reference/chunks/delete-chunk"},{"title":"Create Child Chunk","deprecated":null,"version":null,"sidebarTitle":"Create Child Chunk","openapi":"/en/api-reference/openapi_service.json post /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks","href":"/en/api-reference/chunks/create-child-chunk"},{"title":"List Child Chunks","deprecated":null,"version":null,"sidebarTitle":"List Child Chunks","openapi":"/en/api-reference/openapi_service.json get /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks","href":"/en/api-reference/chunks/list-child-chunks"},{"title":"Update Child Chunk","deprecated":null,"version":null,"sidebarTitle":"Update Child Chunk","openapi":"/en/api-reference/openapi_service.json patch /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks/{child_chunk_id}","href":"/en/api-reference/chunks/update-child-chunk"},{"title":"Delete Child Chunk","deprecated":null,"version":null,"sidebarTitle":"Delete Child Chunk","openapi":"/en/api-reference/openapi_service.json delete /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks/{child_chunk_id}","href":"/en/api-reference/chunks/delete-child-chunk"}]},{"group":"Metadata","pages":[{"title":"Create Metadata Field","deprecated":null,"version":null,"sidebarTitle":"Create Metadata Field","openapi":"/en/api-reference/openapi_service.json post /datasets/{dataset_id}/metadata","href":"/en/api-reference/metadata/create-metadata-field"},{"title":"List Metadata Fields","deprecated":null,"version":null,"sidebarTitle":"List Metadata Fields","openapi":"/en/api-reference/openapi_service.json get /datasets/{dataset_id}/metadata","href":"/en/api-reference/metadata/list-metadata-fields"},{"title":"Update Metadata Field","deprecated":null,"version":null,"sidebarTitle":"Update Metadata Field","openapi":"/en/api-reference/openapi_service.json patch /datasets/{dataset_id}/metadata/{metadata_id}","href":"/en/api-reference/metadata/update-metadata-field"},{"title":"Delete Metadata Field","deprecated":null,"version":null,"sidebarTitle":"Delete Metadata Field","openapi":"/en/api-reference/openapi_service.json delete /datasets/{dataset_id}/metadata/{metadata_id}","href":"/en/api-reference/metadata/delete-metadata-field"},{"title":"Get Built-in Metadata Fields","deprecated":null,"version":null,"sidebarTitle":"Get Built-in Metadata Fields","openapi":"/en/api-reference/openapi_service.json get /datasets/{dataset_id}/metadata/built-in","href":"/en/api-reference/metadata/get-built-in-metadata-fields"},{"title":"Update Built-in Metadata Field","deprecated":null,"version":null,"sidebarTitle":"Update Built-in Metadata Field","openapi":"/en/api-reference/openapi_service.json post /datasets/{dataset_id}/metadata/built-in/{action}","href":"/en/api-reference/metadata/update-built-in-metadata-field"},{"title":"Update Document Metadata in Batch","deprecated":null,"version":null,"sidebarTitle":"Update Document Metadata in Batch","openapi":"/en/api-reference/openapi_service.json post /datasets/{dataset_id}/documents/metadata","href":"/en/api-reference/metadata/update-document-metadata-in-batch"}]},{"group":"Tags","pages":[{"title":"Create Knowledge Tag","deprecated":null,"version":null,"sidebarTitle":"Create Knowledge Tag","openapi":"/en/api-reference/openapi_service.json post /datasets/tags","href":"/en/api-reference/tags/create-knowledge-tag"},{"title":"List Knowledge Tags","deprecated":null,"version":null,"sidebarTitle":"List Knowledge Tags","openapi":"/en/api-reference/openapi_service.json get /datasets/tags","href":"/en/api-reference/tags/list-knowledge-tags"},{"title":"Update Knowledge Tag","deprecated":null,"version":null,"sidebarTitle":"Update Knowledge Tag","openapi":"/en/api-reference/openapi_service.json patch /datasets/tags","href":"/en/api-reference/tags/update-knowledge-tag"},{"title":"Delete Knowledge Tag","deprecated":null,"version":null,"sidebarTitle":"Delete Knowledge Tag","openapi":"/en/api-reference/openapi_service.json delete /datasets/tags","href":"/en/api-reference/tags/delete-knowledge-tag"},{"title":"Create Tag Binding","deprecated":null,"version":null,"sidebarTitle":"Create Tag Binding","openapi":"/en/api-reference/openapi_service.json post /datasets/tags/binding","href":"/en/api-reference/tags/create-tag-binding"},{"title":"Delete Tag Binding","deprecated":null,"version":null,"sidebarTitle":"Delete Tag Binding","openapi":"/en/api-reference/openapi_service.json post /datasets/tags/unbinding","href":"/en/api-reference/tags/delete-tag-binding"},{"title":"Get Knowledge Base Tags","deprecated":null,"version":null,"sidebarTitle":"Get Knowledge Base Tags","openapi":"/en/api-reference/openapi_service.json get /datasets/{dataset_id}/tags","href":"/en/api-reference/tags/get-knowledge-base-tags"}]},{"group":"Models","pages":[{"title":"Get Available Models","deprecated":null,"version":null,"sidebarTitle":"Get Available Models","openapi":"/en/api-reference/openapi_service.json get /workspaces/current/models/model-types/{model_type}","href":"/en/api-reference/models/get-available-models"}]},{"group":"Knowledge Pipeline","pages":[{"title":"Upload Pipeline File","deprecated":null,"version":null,"sidebarTitle":"Upload Pipeline File","openapi":"/en/api-reference/openapi_service.json post /datasets/pipeline/file-upload","href":"/en/api-reference/knowledge-pipeline/upload-pipeline-file"},{"title":"List Datasource Plugins","deprecated":null,"version":null,"sidebarTitle":"List Datasource Plugins","openapi":"/en/api-reference/openapi_service.json get /datasets/{dataset_id}/pipeline/datasource-plugins","href":"/en/api-reference/knowledge-pipeline/list-datasource-plugins"},{"title":"Run Datasource Node","deprecated":null,"version":null,"sidebarTitle":"Run Datasource Node","openapi":"/en/api-reference/openapi_service.json post /datasets/{dataset_id}/pipeline/datasource/nodes/{node_id}/run","href":"/en/api-reference/knowledge-pipeline/run-datasource-node"},{"title":"Run Pipeline","deprecated":null,"version":null,"sidebarTitle":"Run Pipeline","openapi":"/en/api-reference/openapi_service.json post /datasets/{dataset_id}/pipeline/run","href":"/en/api-reference/knowledge-pipeline/run-pipeline"}]}]}]},{"item":"CLI","icon":"terminal","groups":[{"group":" ","expanded":true,"pages":[{"title":"Overview","href":"/en/cli/overview"},{"title":"Get Started","href":"/en/cli/get-started"},{"title":"Find and Run Commands","href":"/en/cli/find-and-run-commands"},{"group":"Work with Apps","expanded":true,"pages":[{"title":"Build Apps","sidebarTitle":"Build","href":"/en/cli/build-apps"},{"title":"Run Apps","sidebarTitle":"Run","href":"/en/cli/run-apps"},{"title":"Create and Update Apps from DSL Files","sidebarTitle":"Create or Update from DSL","href":"/en/cli/create-and-update-apps-from-dsl-files"},{"title":"Use `difyctl` in CI and Automation","sidebarTitle":"CI and Automation","href":"/en/cli/scripts-and-ci"}]},{"group":"Manage difyctl","expanded":true,"pages":[{"title":"Manage Your Sign-In","sidebarTitle":"Sign-In and Sessions","href":"/en/cli/manage-sign-in"},{"title":"Update or Uninstall difyctl","sidebarTitle":"Update or Uninstall","href":"/en/cli/update-or-uninstall"},{"title":"Upgrade Across Dify 1.18.0","sidebarTitle":"Upgrade Across 1.18.0","href":"/en/cli/upgrade-across-1-18"}]},{"group":"Reference","expanded":true,"pages":[{"title":"Command Index","href":"/en/cli/reference/command-index"},{"title":"Results, Errors, and Exit Codes","sidebarTitle":"Results and Errors","href":"/en/cli/reference/results-errors-and-exit-codes"},{"title":"Configuration","href":"/en/cli/reference/configuration"}]}]}]},{"item":"Plugins","icon":"code-pull-request","groups":[{"group":"Getting Started","icon":"rocket","pages":[{"title":"Dify Plugin","href":"/en/develop-plugin/getting-started/getting-started-dify-plugin"},{"title":"Choose a Plugin Type","href":"/en/develop-plugin/getting-started/choose-plugin-type"},{"title":"Dify Plugin CLI","href":"/en/develop-plugin/getting-started/cli"}]},{"group":"Features \u0026 Specs","icon":"list-check","pages":[{"group":"Plugin Types","pages":[{"title":"General Specs","href":"/en/develop-plugin/features-and-specs/plugin-types/general-specifications"},{"title":"Model Specs","href":"/en/develop-plugin/features-and-specs/plugin-types/model-designing-rules"},{"title":"Model API Interface","href":"/en/develop-plugin/features-and-specs/plugin-types/model-schema"},{"title":"Persistent Storage","href":"/en/develop-plugin/features-and-specs/plugin-types/persistent-storage-kv"},{"title":"Tool Return","href":"/en/develop-plugin/features-and-specs/plugin-types/tool"},{"title":"Manifest","href":"/en/develop-plugin/features-and-specs/plugin-types/plugin-info-by-manifest"},{"title":"Multilingual README","href":"/en/develop-plugin/features-and-specs/plugin-types/multilingual-readme"},{"title":"Plugin Debugging","href":"/en/develop-plugin/features-and-specs/plugin-types/remote-debug-a-plugin"},{"title":"Plugin Logging","href":"/en/develop-plugin/features-and-specs/plugin-types/plugin-logging"}]},{"group":"Advanced Development","pages":[{"group":"Reverse Calling","pages":[{"title":"Bundle Plugin Package","href":"/en/develop-plugin/features-and-specs/advanced-development/bundle"},{"title":"Reverse Invocation of Dify Services","href":"/en/develop-plugin/features-and-specs/advanced-development/reverse-invocation"},{"title":"App","href":"/en/develop-plugin/features-and-specs/advanced-development/reverse-invocation-app"},{"title":"Reverse Invocation Model","href":"/en/develop-plugin/features-and-specs/advanced-development/reverse-invocation-model"},{"title":"Tool","href":"/en/develop-plugin/features-and-specs/advanced-development/reverse-invocation-tool"},{"title":"Integrate Custom Models","href":"/en/develop-plugin/features-and-specs/advanced-development/customizable-model"},{"title":"Node","href":"/en/develop-plugin/features-and-specs/advanced-development/reverse-invocation-node"}]}]}]},{"group":"Development Guides \u0026 Walkthroughs","icon":"code","pages":[{"title":"Cheatsheet","href":"/en/develop-plugin/dev-guides-and-walkthroughs/cheatsheet"},{"group":"By Plugin Type","pages":[{"title":"Tool Plugin","href":"/en/develop-plugin/dev-guides-and-walkthroughs/tool-plugin"},{"title":"Tool OAuth","href":"/en/develop-plugin/dev-guides-and-walkthroughs/tool-oauth"},{"title":"Model Provider Plugin","href":"/en/develop-plugin/dev-guides-and-walkthroughs/creating-new-model-provider"},{"title":"Agent Strategy Plugin","href":"/en/develop-plugin/dev-guides-and-walkthroughs/agent-strategy-plugin"},{"title":"Data Source Plugin","href":"/en/develop-plugin/dev-guides-and-walkthroughs/datasource-plugin"},{"title":"Trigger Plugin","href":"/en/develop-plugin/dev-guides-and-walkthroughs/trigger-plugin"},{"title":"Endpoint Plugin","href":"/en/develop-plugin/dev-guides-and-walkthroughs/endpoint"}]},{"group":"Full Walkthroughs","pages":[{"title":"Flomo Tool (10-min)","href":"/en/develop-plugin/dev-guides-and-walkthroughs/develop-flomo-plugin"},{"title":"Slack Bot","href":"/en/develop-plugin/dev-guides-and-walkthroughs/develop-a-slack-bot-plugin"},{"title":"Markdown Exporter","href":"/en/develop-plugin/dev-guides-and-walkthroughs/develop-md-exporter"},{"title":"Multimodal Tool","href":"/en/develop-plugin/dev-guides-and-walkthroughs/develop-multimodal-data-processing-tool"}]}]},{"group":"Publishing","icon":"upload","pages":[{"title":"Publish Plugins","href":"/en/develop-plugin/publishing/marketplace-listing/release-overview"},{"group":"Standards","pages":[{"title":"Plugin Development Guidelines","href":"/en/develop-plugin/publishing/standards/contributor-covenant-code-of-conduct"},{"title":"Privacy Guidelines","href":"/en/develop-plugin/publishing/standards/privacy-protection-guidelines"}]},{"title":"Publish a Plugin to Marketplace","sidebarTitle":"Marketplace","href":"/en/develop-plugin/publishing/marketplace-listing/submit-plugin-to-marketplace"},{"group":"GitHub Repository","pages":[{"title":"Publish to Individual GitHub Repository","href":"/en/develop-plugin/publishing/marketplace-listing/release-to-individual-github-repo"}]},{"group":"Local File","pages":[{"title":"Package as Local File and Share","href":"/en/develop-plugin/publishing/marketplace-listing/release-by-file"},{"title":"Sign Plugins for Third-Party Signature Verification","href":"/en/develop-plugin/publishing/standards/third-party-signature-verification"}]},{"title":"Frequently Asked Questions","sidebarTitle":"FAQ","href":"/en/develop-plugin/publishing/faq/faq"}]}]}]}]}]},{"language":"zh","products":[{"product":"Cloud","icon":"cloud","tabs":[{"tab":"使用","icon":"book-open","pages":[{"title":"使用 Dify","sidebarTitle":"概览","mode":"frame","href":"/zh/cloud/use-dify/getting-started/introduction"},{"title":"Dify 文档","mode":"custom","hidden":true,"href":"/zh/home"},{"group":"编排","icon":"hammer","pages":[{"group":"Workflow 与 Chatflow","expanded":false,"pages":[{"title":"Workflow 与 Chatflow","sidebarTitle":"概述","href":"/zh/cloud/use-dify/build/workflow-chatflow"},{"title":"编排逻辑","href":"/zh/cloud/use-dify/build/orchestrate-node"},{"group":"节点","expanded":false,"pages":[{"group":"开始","root":{"title":"开始节点","href":"/zh/cloud/use-dify/nodes/start"},"pages":[{"title":"用户输入","href":"/zh/cloud/use-dify/nodes/user-input"},{"group":"触发器","root":{"title":"触发器","sidebarTitle":"概述","href":"/zh/cloud/use-dify/nodes/trigger/overview"},"pages":[{"title":"定时触发器","href":"/zh/cloud/use-dify/nodes/trigger/schedule-trigger"},{"title":"集成触发器","href":"/zh/cloud/use-dify/nodes/trigger/plugin-trigger"},{"title":"Webhook 触发器","href":"/zh/cloud/use-dify/nodes/trigger/webhook-trigger"}]}]},{"title":"大语言模型","href":"/zh/cloud/use-dify/nodes/llm"},{"title":"知识检索","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"},{"group":"Web App","pages":[{"title":"Workflow Web 应用","href":"/zh/cloud/use-dify/publish/webapp/workflow-webapp"},{"title":"聊天 Web App","href":"/zh/cloud/use-dify/publish/webapp/chatflow-webapp"},{"title":"Web App 设置","href":"/zh/cloud/use-dify/publish/webapp/web-app-settings"},{"title":"嵌入 Web 应用","sidebarTitle":"嵌入","href":"/zh/cloud/use-dify/publish/webapp/embedding-in-websites"}]},{"title":"MCP 服务器","href":"/zh/cloud/use-dify/publish/publish-mcp"},{"title":"发布应用到市场","sidebarTitle":"市场","href":"/zh/cloud/use-dify/publish/publish-to-marketplace"}]},{"group":"监控","icon":"chart-line","expanded":false,"pages":[{"title":"仪表盘","href":"/zh/cloud/use-dify/monitor/analysis"},{"title":"日志","href":"/zh/cloud/use-dify/monitor/logs"},{"title":"标注系统","href":"/zh/cloud/use-dify/monitor/annotation-reply"},{"group":"集成","pages":[{"title":"集成 LangSmith","href":"/zh/cloud/use-dify/monitor/integrations/integrate-langsmith"},{"title":"集成 Langfuse","href":"/zh/cloud/use-dify/monitor/integrations/integrate-langfuse"},{"title":"集成 Opik","href":"/zh/cloud/use-dify/monitor/integrations/integrate-opik"},{"title":"集成 W\u0026B Weave","href":"/zh/cloud/use-dify/monitor/integrations/integrate-weave"},{"title":"集成 Arize","href":"/zh/cloud/use-dify/monitor/integrations/integrate-arize"},{"title":"集成 Phoenix","href":"/zh/cloud/use-dify/monitor/integrations/integrate-phoenix"},{"title":"集成阿里云云监控","href":"/zh/cloud/use-dify/monitor/integrations/integrate-aliyun"}]}]},{"group":"知识库","icon":"book","expanded":false,"pages":[{"title":"知识库","sidebarTitle":"概述","href":"/zh/cloud/use-dify/knowledge/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":"管理应用","href":"/zh/cloud/use-dify/workspace/app-management"},{"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"},{"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":"知识库","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/cloud/cli/overview"},{"title":"安装 difyctl","sidebarTitle":"安装","href":"/zh/cloud/cli/install"},{"title":"快速开始","href":"/zh/cloud/cli/quick-start"},{"title":"认证","href":"/zh/cloud/cli/authenticate"},{"title":"常见任务","href":"/zh/cloud/cli/common-tasks"},{"group":"集成你的 Agent","pages":[{"title":"将你的 Agent 接入 Dify 应用","sidebarTitle":"概述","href":"/zh/cloud/cli/integrate-agents/overview"},{"title":"在 Agent 运行的位置进行认证","sidebarTitle":"认证","href":"/zh/cloud/cli/integrate-agents/auth-for-agent-deployments"},{"title":"安装 difyctl 技能","href":"/zh/cloud/cli/integrate-agents/install-the-difyctl-skill"},{"title":"处理错误与重试","href":"/zh/cloud/cli/integrate-agents/error-handling-and-retries-for-agents"}]},{"group":"CLI 参考","pages":[{"title":"命令索引","href":"/zh/cloud/cli/reference/command-index"},{"title":"全局标志","href":"/zh/cloud/cli/reference/global-flags"},{"title":"输出格式与退出码","href":"/zh/cloud/cli/reference/output-formats-and-exit-codes"},{"title":"环境变量","href":"/zh/cloud/cli/reference/environment-variables"},{"group":"命令","expanded":true,"pages":[{"title":"应用","href":"/zh/cloud/cli/reference/apps"},{"title":"认证与上下文","href":"/zh/cloud/cli/reference/auth-and-contexts"},{"title":"工作空间","href":"/zh/cloud/cli/reference/workspaces"},{"title":"帮助","href":"/zh/cloud/cli/reference/help"},{"title":"技能","href":"/zh/cloud/cli/reference/skills"},{"title":"版本","href":"/zh/cloud/cli/reference/version"}]}]},{"title":"故障排查","href":"/zh/cloud/cli/troubleshooting"}]}]},{"item":"插件开发","icon":"code-pull-request","groups":[{"group":"快速开始","icon":"rocket","pages":[{"title":"Dify 插件","href":"/zh/develop-plugin/getting-started/getting-started-dify-plugin"},{"title":"选择插件类型","href":"/zh/develop-plugin/getting-started/choose-plugin-type"},{"title":"Dify 插件 CLI","href":"/zh/develop-plugin/getting-started/cli"}]},{"group":"特性与规范","icon":"list-check","pages":[{"group":"插件类型","pages":[{"title":"通用规范","href":"/zh/develop-plugin/features-and-specs/plugin-types/general-specifications"},{"title":"模型规范","href":"/zh/develop-plugin/features-and-specs/plugin-types/model-designing-rules"},{"title":"模型 API 接口","href":"/zh/develop-plugin/features-and-specs/plugin-types/model-schema"},{"title":"持久化存储","href":"/zh/develop-plugin/features-and-specs/plugin-types/persistent-storage-kv"},{"title":"工具返回","href":"/zh/develop-plugin/features-and-specs/plugin-types/tool"},{"title":"Manifest","href":"/zh/develop-plugin/features-and-specs/plugin-types/plugin-info-by-manifest"},{"title":"多语言 README","href":"/zh/develop-plugin/features-and-specs/plugin-types/multilingual-readme"},{"title":"插件调试","href":"/zh/develop-plugin/features-and-specs/plugin-types/remote-debug-a-plugin"},{"title":"输出插件日志","href":"/zh/develop-plugin/features-and-specs/plugin-types/plugin-logging"}]},{"group":"高级开发","pages":[{"group":"反向调用","pages":[{"title":"Bundle 插件包","href":"/zh/develop-plugin/features-and-specs/advanced-development/bundle"},{"title":"Dify 服务的反向调用","href":"/zh/develop-plugin/features-and-specs/advanced-development/reverse-invocation"},{"title":"应用","href":"/zh/develop-plugin/features-and-specs/advanced-development/reverse-invocation-app"},{"title":"反向调用模型","href":"/zh/develop-plugin/features-and-specs/advanced-development/reverse-invocation-model"},{"title":"工具","href":"/zh/develop-plugin/features-and-specs/advanced-development/reverse-invocation-tool"},{"title":"集成自定义模型","href":"/zh/develop-plugin/features-and-specs/advanced-development/customizable-model"},{"title":"节点","href":"/zh/develop-plugin/features-and-specs/advanced-development/reverse-invocation-node"}]}]}]},{"group":"开发指南与示例","icon":"code","pages":[{"title":"速查表","href":"/zh/develop-plugin/dev-guides-and-walkthroughs/cheatsheet"},{"group":"按插件类型","pages":[{"title":"工具插件","href":"/zh/develop-plugin/dev-guides-and-walkthroughs/tool-plugin"},{"title":"Tool OAuth","href":"/zh/develop-plugin/dev-guides-and-walkthroughs/tool-oauth"},{"title":"模型供应商插件","href":"/zh/develop-plugin/dev-guides-and-walkthroughs/creating-new-model-provider"},{"title":"Agent 策略插件","href":"/zh/develop-plugin/dev-guides-and-walkthroughs/agent-strategy-plugin"},{"title":"数据源插件","href":"/zh/develop-plugin/dev-guides-and-walkthroughs/datasource-plugin"},{"title":"触发器插件","href":"/zh/develop-plugin/dev-guides-and-walkthroughs/trigger-plugin"},{"title":"Endpoint 插件","href":"/zh/develop-plugin/dev-guides-and-walkthroughs/endpoint"}]},{"group":"完整示例","pages":[{"title":"Flomo 工具(10分钟)","href":"/zh/develop-plugin/dev-guides-and-walkthroughs/develop-flomo-plugin"},{"title":"Slack Bot","href":"/zh/develop-plugin/dev-guides-and-walkthroughs/develop-a-slack-bot-plugin"},{"title":"Markdown 导出器","href":"/zh/develop-plugin/dev-guides-and-walkthroughs/develop-md-exporter"},{"title":"多模态工具","href":"/zh/develop-plugin/dev-guides-and-walkthroughs/develop-multimodal-data-processing-tool"}]}]},{"group":"发布","icon":"upload","pages":[{"title":"发布插件","href":"/zh/develop-plugin/publishing/marketplace-listing/release-overview"},{"group":"标准","pages":[{"title":"插件开发指南","href":"/zh/develop-plugin/publishing/standards/contributor-covenant-code-of-conduct"},{"title":"隐私政策指南","href":"/zh/develop-plugin/publishing/standards/privacy-protection-guidelines"}]},{"title":"发布插件到市场","sidebarTitle":"市场","href":"/zh/develop-plugin/publishing/marketplace-listing/submit-plugin-to-marketplace"},{"group":"GitHub 仓库","pages":[{"title":"发布到个人 GitHub 仓库","href":"/zh/develop-plugin/publishing/marketplace-listing/release-to-individual-github-repo"}]},{"group":"本地文件","pages":[{"title":"打包为本地文件并分享","href":"/zh/develop-plugin/publishing/marketplace-listing/release-by-file"},{"title":"为第三方签名验证签署插件","href":"/zh/develop-plugin/publishing/standards/third-party-signature-verification"}]},{"title":"常见问题","sidebarTitle":"常见问题","href":"/zh/develop-plugin/publishing/faq/faq"}]}]}]}]},{"product":"自部署","icon":"server","tabs":[{"tab":"部署","icon":"server","pages":[{"title":"部署 Dify","sidebarTitle":"概览","mode":"frame","href":"/zh/self-host/deploy/overview"},{"group":"快速开始","icon":"rocket","pages":[{"title":"使用 Docker Compose 部署 Dify","sidebarTitle":"Docker Compose","href":"/zh/self-host/deploy/quick-start/docker-compose"},{"title":"常见问题","href":"/zh/self-host/deploy/quick-start/faqs"}]},{"group":"进阶部署","icon":"server","pages":[{"title":"使用源代码本地启动","href":"/zh/self-host/deploy/advanced-deployments/local-source-code"},{"title":"单独启动前端 Docker 容器","href":"/zh/self-host/deploy/advanced-deployments/start-the-frontend-docker-container"}]},{"group":"配置","icon":"gear","pages":[{"title":"环境变量","href":"/zh/self-host/deploy/configuration/environments"}]},{"group":"平台指南","icon":"map","pages":[{"title":"使用 aaPanel 部署","href":"/zh/self-host/deploy/platform-guides/bt-panel"},{"title":"AWS 上的 Dify Premium","href":"/zh/self-host/deploy/platform-guides/dify-premium"}]},{"group":"故障排除","icon":"wrench","pages":[{"title":"常见问题","href":"/zh/self-host/deploy/troubleshooting/common-issues"},{"title":"Docker 问题","href":"/zh/self-host/deploy/troubleshooting/docker-issues"},{"title":"第三方集成","href":"/zh/self-host/deploy/troubleshooting/integrations"},{"title":"存储与迁移","href":"/zh/self-host/deploy/troubleshooting/storage-and-migration"},{"title":"Weaviate 迁移指南:升级到客户端 v4 和服务器 1.27+","href":"/zh/self-host/deploy/troubleshooting/weaviate-v4-migration"},{"title":"Weaviate 服务器升级路径","href":"/zh/self-host/deploy/troubleshooting/weaviate-server-migration-path"}]}]},{"tab":"使用","icon":"book-open","pages":[{"title":"使用 Dify","sidebarTitle":"概览","mode":"frame","href":"/zh/self-host/use-dify/getting-started/introduction"},{"group":"编排","icon":"hammer","pages":[{"group":"Workflow 与 Chatflow","expanded":false,"pages":[{"title":"Workflow 与 Chatflow","sidebarTitle":"概述","href":"/zh/self-host/use-dify/build/workflow-chatflow"},{"title":"编排逻辑","href":"/zh/self-host/use-dify/build/orchestrate-node"},{"group":"节点","expanded":false,"pages":[{"group":"开始","root":{"title":"开始节点","href":"/zh/self-host/use-dify/nodes/start"},"pages":[{"title":"用户输入","href":"/zh/self-host/use-dify/nodes/user-input"},{"group":"触发器","root":{"title":"触发器","sidebarTitle":"概述","href":"/zh/self-host/use-dify/nodes/trigger/overview"},"pages":[{"title":"定时触发器","href":"/zh/self-host/use-dify/nodes/trigger/schedule-trigger"},{"title":"集成触发器","href":"/zh/self-host/use-dify/nodes/trigger/plugin-trigger"},{"title":"Webhook 触发器","href":"/zh/self-host/use-dify/nodes/trigger/webhook-trigger"}]}]},{"title":"大语言模型","href":"/zh/self-host/use-dify/nodes/llm"},{"title":"知识检索","href":"/zh/self-host/use-dify/nodes/knowledge-retrieval"},{"title":"直接回复","href":"/zh/self-host/use-dify/nodes/answer"},{"title":"输出","href":"/zh/self-host/use-dify/nodes/output"},{"title":"Agent","href":"/zh/self-host/use-dify/nodes/agent"},{"title":"问题分类器","href":"/zh/self-host/use-dify/nodes/question-classifier"},{"title":"If-Else","href":"/zh/self-host/use-dify/nodes/ifelse"},{"group":"人工介入","root":{"title":"人工介入","href":"/zh/self-host/use-dify/nodes/human-input"},"expanded":false,"pages":[]},{"title":"迭代","href":"/zh/self-host/use-dify/nodes/iteration"},{"title":"循环","href":"/zh/self-host/use-dify/nodes/loop"},{"title":"代码","href":"/zh/self-host/use-dify/nodes/code"},{"title":"模板转换","href":"/zh/self-host/use-dify/nodes/template"},{"title":"变量聚合器","href":"/zh/self-host/use-dify/nodes/variable-aggregator"},{"title":"文档提取器","href":"/zh/self-host/use-dify/nodes/doc-extractor"},{"title":"变量赋值器","href":"/zh/self-host/use-dify/nodes/variable-assigner"},{"title":"参数提取器","href":"/zh/self-host/use-dify/nodes/parameter-extractor"},{"title":"HTTP 请求","href":"/zh/self-host/use-dify/nodes/http-request"},{"title":"列表操作符","href":"/zh/self-host/use-dify/nodes/list-operator"},{"title":"工具节点","sidebarTitle":"工具","href":"/zh/self-host/use-dify/nodes/tools"}]},{"title":"快捷键","href":"/zh/self-host/use-dify/build/shortcut-key"},{"title":"版本控制","href":"/zh/self-host/use-dify/build/version-control"},{"title":"Snippets","href":"/zh/self-host/use-dify/build/snippet"},{"title":"与团队成员协作","sidebarTitle":"协作","href":"/zh/self-host/use-dify/build/workflow-collaboration"},{"group":"调试","expanded":false,"pages":[{"title":"处理错误","href":"/zh/self-host/use-dify/build/predefined-error-handling-logic"},{"title":"单节点","href":"/zh/self-host/use-dify/debug/step-run"},{"title":"变量检查器","href":"/zh/self-host/use-dify/debug/variable-inspect"},{"title":"运行历史","href":"/zh/self-host/use-dify/debug/history-and-logs"},{"title":"错误类型","href":"/zh/self-host/use-dify/debug/error-type"}]}]},{"group":"Agent","tag":"New","expanded":false,"pages":[{"title":"Agent","sidebarTitle":"概述","href":"/zh/self-host/use-dify/build/new-agent/overview"},{"title":"构建 Agent","sidebarTitle":"构建","href":"/zh/self-host/use-dify/build/new-agent/build"}]},{"title":"Skills","sidebarTitle":"Skills","href":"/zh/self-host/use-dify/build/skills"},{"group":"基础应用","expanded":false,"pages":[{"title":"Agent","tag":"Legacy","href":"/zh/self-host/use-dify/build/agent"},{"title":"聊天助手","sidebarTitle":"聊天助手","href":"/zh/self-host/use-dify/build/chatbot"},{"title":"文本生成应用","sidebarTitle":"文本生成应用","href":"/zh/self-host/use-dify/build/text-generator"}]},{"title":"应用工具箱","href":"/zh/self-host/use-dify/build/additional-features"},{"title":"全局搜索","href":"/zh/self-host/use-dify/build/goto-anything"}]},{"group":"发布","icon":"paper-plane","expanded":false,"pages":[{"title":"分享你的 AI 应用","href":"/zh/self-host/use-dify/publish/README"},{"group":"Web App","pages":[{"title":"Workflow Web 应用","href":"/zh/self-host/use-dify/publish/webapp/workflow-webapp"},{"title":"聊天 Web App","href":"/zh/self-host/use-dify/publish/webapp/chatflow-webapp"},{"title":"Web App 设置","href":"/zh/self-host/use-dify/publish/webapp/web-app-settings"},{"title":"嵌入 Web 应用","sidebarTitle":"嵌入","href":"/zh/self-host/use-dify/publish/webapp/embedding-in-websites"}]},{"title":"MCP 服务器","href":"/zh/self-host/use-dify/publish/publish-mcp"},{"title":"发布应用到市场","sidebarTitle":"市场","href":"/zh/self-host/use-dify/publish/publish-to-marketplace"}]},{"group":"监控","icon":"chart-line","expanded":false,"pages":[{"title":"仪表盘","href":"/zh/self-host/use-dify/monitor/analysis"},{"title":"日志","href":"/zh/self-host/use-dify/monitor/logs"},{"title":"标注系统","href":"/zh/self-host/use-dify/monitor/annotation-reply"},{"group":"集成","pages":[{"title":"集成 LangSmith","href":"/zh/self-host/use-dify/monitor/integrations/integrate-langsmith"},{"title":"集成 Langfuse","href":"/zh/self-host/use-dify/monitor/integrations/integrate-langfuse"},{"title":"集成 Opik","href":"/zh/self-host/use-dify/monitor/integrations/integrate-opik"},{"title":"集成 W\u0026B Weave","href":"/zh/self-host/use-dify/monitor/integrations/integrate-weave"},{"title":"集成 Arize","href":"/zh/self-host/use-dify/monitor/integrations/integrate-arize"},{"title":"集成 Phoenix","href":"/zh/self-host/use-dify/monitor/integrations/integrate-phoenix"},{"title":"集成阿里云云监控","href":"/zh/self-host/use-dify/monitor/integrations/integrate-aliyun"}]}]},{"group":"知识库","icon":"book","expanded":false,"pages":[{"title":"知识库","sidebarTitle":"概述","href":"/zh/self-host/use-dify/knowledge/readme"},{"group":"创建","pages":[{"group":"创建即用型知识库","pages":[{"title":"创建即用型知识库","sidebarTitle":"概述","href":"/zh/self-host/use-dify/knowledge/create-knowledge/introduction"},{"group":"导入数据","pages":[{"title":"上传本地文件","href":"/zh/self-host/use-dify/knowledge/create-knowledge/import-text-data/readme"},{"title":"从 Notion 导入数据","href":"/zh/self-host/use-dify/knowledge/create-knowledge/import-text-data/sync-from-notion"},{"title":"从网页导入数据","href":"/zh/self-host/use-dify/knowledge/create-knowledge/import-text-data/sync-from-website"}]},{"title":"指定分段设置","sidebarTitle":"设置分段","href":"/zh/self-host/use-dify/knowledge/create-knowledge/chunking-and-cleaning-text"},{"title":"指定索引方式与检索设置","sidebarTitle":"设置索引与检索","href":"/zh/self-host/use-dify/knowledge/create-knowledge/setting-indexing-methods"}]},{"group":"构建自定义知识库","pages":[{"title":"构建自定义知识库","sidebarTitle":"概述","href":"/zh/self-host/use-dify/knowledge/knowledge-pipeline/readme"},{"title":"步骤一:创建知识流水线","href":"/zh/self-host/use-dify/knowledge/knowledge-pipeline/create-knowledge-pipeline"},{"title":"步骤二:编排知识流水线","href":"/zh/self-host/use-dify/knowledge/knowledge-pipeline/knowledge-pipeline-orchestration"},{"title":"步骤三:发布知识流水线","href":"/zh/self-host/use-dify/knowledge/knowledge-pipeline/publish-knowledge-pipeline"},{"title":"步骤四:上传文件","href":"/zh/self-host/use-dify/knowledge/knowledge-pipeline/upload-files"},{"title":"步骤五:管理和使用知识库","href":"/zh/self-host/use-dify/knowledge/knowledge-pipeline/manage-knowledge-base"},{"title":"数据源授权","href":"/zh/self-host/use-dify/knowledge/knowledge-pipeline/authorize-data-source"}]},{"group":"连接外部知识库","pages":[{"title":"连接外部知识库","sidebarTitle":"概述","href":"/zh/self-host/use-dify/knowledge/connect-external-knowledge-base"},{"title":"外部知识库 API","href":"/zh/self-host/use-dify/knowledge/external-knowledge-api"}]}]},{"group":"管理","pages":[{"title":"维护知识库内容","sidebarTitle":"文档与分段","href":"/zh/self-host/use-dify/knowledge/manage-knowledge/maintain-knowledge-documents"},{"title":"管理文档元数据","sidebarTitle":"元数据","href":"/zh/self-host/use-dify/knowledge/metadata"},{"title":"调整知识库设置","sidebarTitle":"设置","href":"/zh/self-host/use-dify/knowledge/manage-knowledge/introduction"}]},{"title":"测试检索","sidebarTitle":"调试","href":"/zh/self-host/use-dify/knowledge/test-retrieval"},{"title":"在应用内集成知识库","sidebarTitle":"在应用内集成","href":"/zh/self-host/use-dify/knowledge/integrate-knowledge-within-application"}]},{"group":"集成","icon":"plug","expanded":false,"pages":[{"title":"集成","sidebarTitle":"概览","href":"/zh/self-host/use-dify/workspace/plugins"},{"title":"模型供应商","href":"/zh/self-host/use-dify/workspace/model-providers"},{"title":"Dify 工具","sidebarTitle":"工具","href":"/zh/self-host/use-dify/workspace/tools"},{"group":"自定义端点","pages":[{"title":"自定义端点","sidebarTitle":"概述","href":"/zh/self-host/use-dify/workspace/api-extension/api-extension"},{"title":"外部数据工具","href":"/zh/self-host/use-dify/workspace/api-extension/external-data-tool-api-extension"},{"title":"敏感内容审查","href":"/zh/self-host/use-dify/workspace/api-extension/moderation-api-extension"},{"title":"使用 Cloudflare Workers 部署自定义端点","href":"/zh/self-host/use-dify/workspace/api-extension/cloudflare-worker"}]}]},{"group":"工作空间","icon":"briefcase","expanded":false,"pages":[{"title":"工作空间","sidebarTitle":"概述","href":"/zh/self-host/use-dify/workspace/readme"},{"title":"导出和导入应用","sidebarTitle":"导出和导入","href":"/zh/self-host/use-dify/workspace/export-import-apps"},{"title":"管理成员","href":"/zh/self-host/use-dify/workspace/team-members-management"},{"title":"个人设置","href":"/zh/self-host/use-dify/workspace/personal-account-management"}]}]},{"tab":"学习","icon":"graduation-cap","pages":[{"title":"核心概念","href":"/zh/learn/key-concepts"},{"group":"教程","pages":[{"title":"30 分钟快速入门","href":"/zh/quick-start"},{"group":"工作流 101","pages":[{"title":"第 1 课:什么是工作流","href":"/zh/learn/tutorials/workflow-101/lesson-01"},{"title":"第 2 课:流程的头和尾(开始与输出节点)","sidebarTitle":"第 2 课:流程的头和尾","href":"/zh/learn/tutorials/workflow-101/lesson-02"},{"title":"第 3 课:工作流的大脑(LLM 节点)","sidebarTitle":"第 3 课:工作流的大脑","href":"/zh/learn/tutorials/workflow-101/lesson-03"},{"title":"第 4 课:小抄(知识检索)","sidebarTitle":"第 4 课:小抄","href":"/zh/learn/tutorials/workflow-101/lesson-04"},{"title":"第 5 课:工作流的岔路口(分类与执行)","sidebarTitle":"第 5 课:工作流的岔路口","href":"/zh/learn/tutorials/workflow-101/lesson-05"},{"title":"第 6 课:处理多个任务(参数提取 \u0026 迭代)","sidebarTitle":"第 6 课:处理多个任务","href":"/zh/learn/tutorials/workflow-101/lesson-06"},{"title":"第 7 课:增强工作流(工具)","sidebarTitle":"第 7 课:增强工作流","href":"/zh/learn/tutorials/workflow-101/lesson-07"},{"title":"第 8 课:Agent 节点","sidebarTitle":"第 8 课:Agent 节点","href":"/zh/learn/tutorials/workflow-101/lesson-08"},{"title":"第 9 课:排版设计师(模板)","sidebarTitle":"第 9 课:排版设计师","href":"/zh/learn/tutorials/workflow-101/lesson-09"},{"title":"第 10 课:发布和监控你的 AI 应用","sidebarTitle":"第 10 课:发布和监控","href":"/zh/learn/tutorials/workflow-101/lesson-10"}]},{"title":"简单聊天机器人","href":"/zh/learn/tutorials/simple-chatbot"},{"title":"ChatFlow 实战:搭建 Twitter 账号分析助手","href":"/zh/learn/tutorials/twitter-chatflow"},{"title":"使用知识库搭建智能客服机器人","href":"/zh/learn/tutorials/customer-service-bot"},{"title":"如何搭建 AI 图片生成应用","href":"/zh/learn/tutorials/build-ai-image-generation-app"},{"title":"使用文件上传搭建文章理解助手","href":"/zh/learn/tutorials/article-reader"}]}]},{"tab":"开发者资源","icon":"code","menu":[{"item":"API","icon":"code","groups":[{"group":"指南","pages":[{"title":"Dify API 快速开始","sidebarTitle":"快速开始","href":"/zh/api-reference/guides/get-started"},{"group":"API 概览","expanded":true,"pages":[{"title":"Chatflow 应用 API","sidebarTitle":"Chatflow","href":"/zh/api-reference/guides/chatflow"},{"title":"Workflow 应用 API","sidebarTitle":"Workflow","href":"/zh/api-reference/guides/workflow"},{"title":"Agent API","sidebarTitle":"Agent","tag":"New","href":"/zh/api-reference/guides/agent"},{"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":"知识库","pages":[{"title":"创建空知识库","deprecated":null,"version":null,"sidebarTitle":"创建空知识库","openapi":"/zh/api-reference/openapi_service.json post /datasets","href":"/zh/api-reference/knowledge-bases/create-an-empty-knowledge-base"},{"title":"获取知识库列表","deprecated":null,"version":null,"sidebarTitle":"获取知识库列表","openapi":"/zh/api-reference/openapi_service.json get /datasets","href":"/zh/api-reference/knowledge-bases/list-knowledge-bases"},{"title":"获取知识库详情","deprecated":null,"version":null,"sidebarTitle":"获取知识库详情","openapi":"/zh/api-reference/openapi_service.json get /datasets/{dataset_id}","href":"/zh/api-reference/knowledge-bases/get-knowledge-base"},{"title":"更新知识库","deprecated":null,"version":null,"sidebarTitle":"更新知识库","openapi":"/zh/api-reference/openapi_service.json patch /datasets/{dataset_id}","href":"/zh/api-reference/knowledge-bases/update-knowledge-base"},{"title":"删除知识库","deprecated":null,"version":null,"sidebarTitle":"删除知识库","openapi":"/zh/api-reference/openapi_service.json delete /datasets/{dataset_id}","href":"/zh/api-reference/knowledge-bases/delete-knowledge-base"},{"title":"从知识库检索分段 / 测试检索","deprecated":null,"version":null,"sidebarTitle":"从知识库检索分段 / 测试检索","openapi":"/zh/api-reference/openapi_service.json post /datasets/{dataset_id}/retrieve","href":"/zh/api-reference/knowledge-bases/retrieve-chunks-from-a-knowledge-base-test-retrieval"}]},{"group":"文档","pages":[{"title":"从文本创建文档","deprecated":null,"version":null,"sidebarTitle":"从文本创建文档","openapi":"/zh/api-reference/openapi_service.json post /datasets/{dataset_id}/document/create-by-text","href":"/zh/api-reference/documents/create-document-by-text"},{"title":"从文件创建文档","deprecated":null,"version":null,"sidebarTitle":"从文件创建文档","openapi":"/zh/api-reference/openapi_service.json post /datasets/{dataset_id}/document/create-by-file","href":"/zh/api-reference/documents/create-document-by-file"},{"title":"获取知识库的文档列表","deprecated":null,"version":null,"sidebarTitle":"获取知识库的文档列表","openapi":"/zh/api-reference/openapi_service.json get /datasets/{dataset_id}/documents","href":"/zh/api-reference/documents/list-documents"},{"title":"获取文档详情","deprecated":null,"version":null,"sidebarTitle":"获取文档详情","openapi":"/zh/api-reference/openapi_service.json get /datasets/{dataset_id}/documents/{document_id}","href":"/zh/api-reference/documents/get-document"},{"title":"删除文档","deprecated":null,"version":null,"sidebarTitle":"删除文档","openapi":"/zh/api-reference/openapi_service.json delete /datasets/{dataset_id}/documents/{document_id}","href":"/zh/api-reference/documents/delete-document"},{"title":"更新文档","deprecated":null,"version":null,"sidebarTitle":"更新文档","openapi":"/zh/api-reference/openapi_service.json patch /datasets/{dataset_id}/documents/{document_id}","href":"/zh/api-reference/documents/update-document"},{"title":"下载文档","deprecated":null,"version":null,"sidebarTitle":"下载文档","openapi":"/zh/api-reference/openapi_service.json get /datasets/{dataset_id}/documents/{document_id}/download","href":"/zh/api-reference/documents/download-document"},{"title":"获取文档嵌入状态(进度)","deprecated":null,"version":null,"sidebarTitle":"获取文档嵌入状态(进度)","openapi":"/zh/api-reference/openapi_service.json get /datasets/{dataset_id}/documents/{batch}/indexing-status","href":"/zh/api-reference/documents/get-document-indexing-status"},{"title":"用文本更新文档","deprecated":null,"version":null,"sidebarTitle":"用文本更新文档","openapi":"/zh/api-reference/openapi_service.json post /datasets/{dataset_id}/documents/{document_id}/update-by-text","href":"/zh/api-reference/documents/update-document-by-text"},{"title":"用文件更新文档","deprecated":true,"version":null,"sidebarTitle":"用文件更新文档","openapi":"/zh/api-reference/openapi_service.json post /datasets/{dataset_id}/documents/{document_id}/update-by-file","href":"/zh/api-reference/documents/update-document-by-file"},{"title":"批量下载文档(ZIP)","deprecated":null,"version":null,"sidebarTitle":"批量下载文档(ZIP)","openapi":"/zh/api-reference/openapi_service.json post /datasets/{dataset_id}/documents/download-zip","href":"/zh/api-reference/documents/download-documents-as-zip"},{"title":"批量更新文档状态","deprecated":null,"version":null,"sidebarTitle":"批量更新文档状态","openapi":"/zh/api-reference/openapi_service.json patch /datasets/{dataset_id}/documents/status/{action}","href":"/zh/api-reference/documents/update-document-status-in-batch"}]},{"group":"分段","pages":[{"title":"向文档添加分段","deprecated":null,"version":null,"sidebarTitle":"向文档添加分段","openapi":"/zh/api-reference/openapi_service.json post /datasets/{dataset_id}/documents/{document_id}/segments","href":"/zh/api-reference/chunks/create-chunks"},{"title":"从文档获取分段","deprecated":null,"version":null,"sidebarTitle":"从文档获取分段","openapi":"/zh/api-reference/openapi_service.json get /datasets/{dataset_id}/documents/{document_id}/segments","href":"/zh/api-reference/chunks/list-chunks"},{"title":"获取文档中的分段详情","deprecated":null,"version":null,"sidebarTitle":"获取文档中的分段详情","openapi":"/zh/api-reference/openapi_service.json get /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}","href":"/zh/api-reference/chunks/get-chunk"},{"title":"更新文档中的分段","deprecated":null,"version":null,"sidebarTitle":"更新文档中的分段","openapi":"/zh/api-reference/openapi_service.json post /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}","href":"/zh/api-reference/chunks/update-chunk"},{"title":"删除文档中的分段","deprecated":null,"version":null,"sidebarTitle":"删除文档中的分段","openapi":"/zh/api-reference/openapi_service.json delete /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}","href":"/zh/api-reference/chunks/delete-chunk"},{"title":"创建子分段","deprecated":null,"version":null,"sidebarTitle":"创建子分段","openapi":"/zh/api-reference/openapi_service.json post /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks","href":"/zh/api-reference/chunks/create-child-chunk"},{"title":"获取子分段","deprecated":null,"version":null,"sidebarTitle":"获取子分段","openapi":"/zh/api-reference/openapi_service.json get /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks","href":"/zh/api-reference/chunks/list-child-chunks"},{"title":"更新子分段","deprecated":null,"version":null,"sidebarTitle":"更新子分段","openapi":"/zh/api-reference/openapi_service.json patch /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks/{child_chunk_id}","href":"/zh/api-reference/chunks/update-child-chunk"},{"title":"删除子分段","deprecated":null,"version":null,"sidebarTitle":"删除子分段","openapi":"/zh/api-reference/openapi_service.json delete /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks/{child_chunk_id}","href":"/zh/api-reference/chunks/delete-child-chunk"}]},{"group":"元数据","pages":[{"title":"创建元数据字段","deprecated":null,"version":null,"sidebarTitle":"创建元数据字段","openapi":"/zh/api-reference/openapi_service.json post /datasets/{dataset_id}/metadata","href":"/zh/api-reference/metadata/create-metadata-field"},{"title":"获取元数据字段列表","deprecated":null,"version":null,"sidebarTitle":"获取元数据字段列表","openapi":"/zh/api-reference/openapi_service.json get /datasets/{dataset_id}/metadata","href":"/zh/api-reference/metadata/list-metadata-fields"},{"title":"更新元数据字段","deprecated":null,"version":null,"sidebarTitle":"更新元数据字段","openapi":"/zh/api-reference/openapi_service.json patch /datasets/{dataset_id}/metadata/{metadata_id}","href":"/zh/api-reference/metadata/update-metadata-field"},{"title":"删除元数据字段","deprecated":null,"version":null,"sidebarTitle":"删除元数据字段","openapi":"/zh/api-reference/openapi_service.json delete /datasets/{dataset_id}/metadata/{metadata_id}","href":"/zh/api-reference/metadata/delete-metadata-field"},{"title":"获取内置元数据字段","deprecated":null,"version":null,"sidebarTitle":"获取内置元数据字段","openapi":"/zh/api-reference/openapi_service.json get /datasets/{dataset_id}/metadata/built-in","href":"/zh/api-reference/metadata/get-built-in-metadata-fields"},{"title":"更新内置元数据字段","deprecated":null,"version":null,"sidebarTitle":"更新内置元数据字段","openapi":"/zh/api-reference/openapi_service.json post /datasets/{dataset_id}/metadata/built-in/{action}","href":"/zh/api-reference/metadata/update-built-in-metadata-field"},{"title":"批量更新文档元数据","deprecated":null,"version":null,"sidebarTitle":"批量更新文档元数据","openapi":"/zh/api-reference/openapi_service.json post /datasets/{dataset_id}/documents/metadata","href":"/zh/api-reference/metadata/update-document-metadata-in-batch"}]},{"group":"标签","pages":[{"title":"创建知识库标签","deprecated":null,"version":null,"sidebarTitle":"创建知识库标签","openapi":"/zh/api-reference/openapi_service.json post /datasets/tags","href":"/zh/api-reference/tags/create-knowledge-tag"},{"title":"获取知识库标签列表","deprecated":null,"version":null,"sidebarTitle":"获取知识库标签列表","openapi":"/zh/api-reference/openapi_service.json get /datasets/tags","href":"/zh/api-reference/tags/list-knowledge-tags"},{"title":"修改知识库标签","deprecated":null,"version":null,"sidebarTitle":"修改知识库标签","openapi":"/zh/api-reference/openapi_service.json patch /datasets/tags","href":"/zh/api-reference/tags/update-knowledge-tag"},{"title":"删除知识库标签","deprecated":null,"version":null,"sidebarTitle":"删除知识库标签","openapi":"/zh/api-reference/openapi_service.json delete /datasets/tags","href":"/zh/api-reference/tags/delete-knowledge-tag"},{"title":"绑定标签到知识库","deprecated":null,"version":null,"sidebarTitle":"绑定标签到知识库","openapi":"/zh/api-reference/openapi_service.json post /datasets/tags/binding","href":"/zh/api-reference/tags/create-tag-binding"},{"title":"解除标签与知识库的绑定","deprecated":null,"version":null,"sidebarTitle":"解除标签与知识库的绑定","openapi":"/zh/api-reference/openapi_service.json post /datasets/tags/unbinding","href":"/zh/api-reference/tags/delete-tag-binding"},{"title":"获取知识库绑定的标签","deprecated":null,"version":null,"sidebarTitle":"获取知识库绑定的标签","openapi":"/zh/api-reference/openapi_service.json get /datasets/{dataset_id}/tags","href":"/zh/api-reference/tags/get-knowledge-base-tags"}]},{"group":"模型","pages":[{"title":"获取可用模型","deprecated":null,"version":null,"sidebarTitle":"获取可用模型","openapi":"/zh/api-reference/openapi_service.json get /workspaces/current/models/model-types/{model_type}","href":"/zh/api-reference/models/get-available-models"}]},{"group":"知识流水线","pages":[{"title":"上传流水线文件","deprecated":null,"version":null,"sidebarTitle":"上传流水线文件","openapi":"/zh/api-reference/openapi_service.json post /datasets/pipeline/file-upload","href":"/zh/api-reference/knowledge-pipeline/upload-pipeline-file"},{"title":"获取数据源插件列表","deprecated":null,"version":null,"sidebarTitle":"获取数据源插件列表","openapi":"/zh/api-reference/openapi_service.json get /datasets/{dataset_id}/pipeline/datasource-plugins","href":"/zh/api-reference/knowledge-pipeline/list-datasource-plugins"},{"title":"执行数据源节点","deprecated":null,"version":null,"sidebarTitle":"执行数据源节点","openapi":"/zh/api-reference/openapi_service.json post /datasets/{dataset_id}/pipeline/datasource/nodes/{node_id}/run","href":"/zh/api-reference/knowledge-pipeline/run-datasource-node"},{"title":"运行流水线","deprecated":null,"version":null,"sidebarTitle":"运行流水线","openapi":"/zh/api-reference/openapi_service.json post /datasets/{dataset_id}/pipeline/run","href":"/zh/api-reference/knowledge-pipeline/run-pipeline"}]}]}]},{"item":"CLI","icon":"terminal","groups":[{"group":" ","expanded":true,"pages":[{"title":"概述","href":"/zh/cli/overview"},{"title":"快速开始","href":"/zh/cli/get-started"},{"title":"查找并运行命令","href":"/zh/cli/find-and-run-commands"},{"group":"应用操作","expanded":true,"pages":[{"title":"构建应用","sidebarTitle":"构建","href":"/zh/cli/build-apps"},{"title":"运行应用","sidebarTitle":"运行","href":"/zh/cli/run-apps"},{"title":"通过 DSL 文件创建和更新应用","sidebarTitle":"通过 DSL 创建或更新","href":"/zh/cli/create-and-update-apps-from-dsl-files"},{"title":"在 CI 和自动化中使用 `difyctl`","sidebarTitle":"CI 和自动化","href":"/zh/cli/scripts-and-ci"}]},{"group":"管理 difyctl","expanded":true,"pages":[{"title":"管理登录","sidebarTitle":"登录与会话","href":"/zh/cli/manage-sign-in"},{"title":"更新或卸载 difyctl","sidebarTitle":"更新或卸载","href":"/zh/cli/update-or-uninstall"},{"title":"Dify 1.18.0 升级指南","sidebarTitle":"1.18.0 升级指南","href":"/zh/cli/upgrade-across-1-18"}]},{"group":"参考","expanded":true,"pages":[{"title":"命令索引","href":"/zh/cli/reference/command-index"},{"title":"结果、错误与退出码","sidebarTitle":"结果与错误","href":"/zh/cli/reference/results-errors-and-exit-codes"},{"title":"配置","href":"/zh/cli/reference/configuration"}]}]}]},{"item":"插件开发","icon":"code-pull-request","groups":[{"group":"快速开始","icon":"rocket","pages":[{"title":"Dify 插件","href":"/zh/develop-plugin/getting-started/getting-started-dify-plugin"},{"title":"选择插件类型","href":"/zh/develop-plugin/getting-started/choose-plugin-type"},{"title":"Dify 插件 CLI","href":"/zh/develop-plugin/getting-started/cli"}]},{"group":"特性与规范","icon":"list-check","pages":[{"group":"插件类型","pages":[{"title":"通用规范","href":"/zh/develop-plugin/features-and-specs/plugin-types/general-specifications"},{"title":"模型规范","href":"/zh/develop-plugin/features-and-specs/plugin-types/model-designing-rules"},{"title":"模型 API 接口","href":"/zh/develop-plugin/features-and-specs/plugin-types/model-schema"},{"title":"持久化存储","href":"/zh/develop-plugin/features-and-specs/plugin-types/persistent-storage-kv"},{"title":"工具返回","href":"/zh/develop-plugin/features-and-specs/plugin-types/tool"},{"title":"Manifest","href":"/zh/develop-plugin/features-and-specs/plugin-types/plugin-info-by-manifest"},{"title":"多语言 README","href":"/zh/develop-plugin/features-and-specs/plugin-types/multilingual-readme"},{"title":"插件调试","href":"/zh/develop-plugin/features-and-specs/plugin-types/remote-debug-a-plugin"},{"title":"输出插件日志","href":"/zh/develop-plugin/features-and-specs/plugin-types/plugin-logging"}]},{"group":"高级开发","pages":[{"group":"反向调用","pages":[{"title":"Bundle 插件包","href":"/zh/develop-plugin/features-and-specs/advanced-development/bundle"},{"title":"Dify 服务的反向调用","href":"/zh/develop-plugin/features-and-specs/advanced-development/reverse-invocation"},{"title":"应用","href":"/zh/develop-plugin/features-and-specs/advanced-development/reverse-invocation-app"},{"title":"反向调用模型","href":"/zh/develop-plugin/features-and-specs/advanced-development/reverse-invocation-model"},{"title":"工具","href":"/zh/develop-plugin/features-and-specs/advanced-development/reverse-invocation-tool"},{"title":"集成自定义模型","href":"/zh/develop-plugin/features-and-specs/advanced-development/customizable-model"},{"title":"节点","href":"/zh/develop-plugin/features-and-specs/advanced-development/reverse-invocation-node"}]}]}]},{"group":"开发指南与示例","icon":"code","pages":[{"title":"速查表","href":"/zh/develop-plugin/dev-guides-and-walkthroughs/cheatsheet"},{"group":"按插件类型","pages":[{"title":"工具插件","href":"/zh/develop-plugin/dev-guides-and-walkthroughs/tool-plugin"},{"title":"Tool OAuth","href":"/zh/develop-plugin/dev-guides-and-walkthroughs/tool-oauth"},{"title":"模型供应商插件","href":"/zh/develop-plugin/dev-guides-and-walkthroughs/creating-new-model-provider"},{"title":"Agent 策略插件","href":"/zh/develop-plugin/dev-guides-and-walkthroughs/agent-strategy-plugin"},{"title":"数据源插件","href":"/zh/develop-plugin/dev-guides-and-walkthroughs/datasource-plugin"},{"title":"触发器插件","href":"/zh/develop-plugin/dev-guides-and-walkthroughs/trigger-plugin"},{"title":"Endpoint 插件","href":"/zh/develop-plugin/dev-guides-and-walkthroughs/endpoint"}]},{"group":"完整示例","pages":[{"title":"Flomo 工具(10分钟)","href":"/zh/develop-plugin/dev-guides-and-walkthroughs/develop-flomo-plugin"},{"title":"Slack Bot","href":"/zh/develop-plugin/dev-guides-and-walkthroughs/develop-a-slack-bot-plugin"},{"title":"Markdown 导出器","href":"/zh/develop-plugin/dev-guides-and-walkthroughs/develop-md-exporter"},{"title":"多模态工具","href":"/zh/develop-plugin/dev-guides-and-walkthroughs/develop-multimodal-data-processing-tool"}]}]},{"group":"发布","icon":"upload","pages":[{"title":"发布插件","href":"/zh/develop-plugin/publishing/marketplace-listing/release-overview"},{"group":"标准","pages":[{"title":"插件开发指南","href":"/zh/develop-plugin/publishing/standards/contributor-covenant-code-of-conduct"},{"title":"隐私政策指南","href":"/zh/develop-plugin/publishing/standards/privacy-protection-guidelines"}]},{"title":"发布插件到市场","sidebarTitle":"市场","href":"/zh/develop-plugin/publishing/marketplace-listing/submit-plugin-to-marketplace"},{"group":"GitHub 仓库","pages":[{"title":"发布到个人 GitHub 仓库","href":"/zh/develop-plugin/publishing/marketplace-listing/release-to-individual-github-repo"}]},{"group":"本地文件","pages":[{"title":"打包为本地文件并分享","href":"/zh/develop-plugin/publishing/marketplace-listing/release-by-file"},{"title":"为第三方签名验证签署插件","href":"/zh/develop-plugin/publishing/standards/third-party-signature-verification"}]},{"title":"常见问题","sidebarTitle":"常见问题","href":"/zh/develop-plugin/publishing/faq/faq"}]}]}]}]}]},{"language":"ja","products":[{"product":"Cloud","icon":"cloud","tabs":[{"tab":"使い方","icon":"book-open","pages":[{"title":"使い方","href":"/ja/cloud/use-dify/getting-started/introduction"}]},{"tab":"学習","icon":"graduation-cap","pages":[{"title":"学習","href":"/ja/learn/key-concepts"}]},{"tab":"開発者リソース","icon":"code","menu":[{"item":"API","icon":"code","pages":[{"title":"API","href":"/ja/api-reference/guides/get-started"}]},{"item":"CLI","icon":"terminal","pages":[{"title":"CLI","href":"/ja/cloud/cli/overview"}]},{"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":"永続ストレージ","description":"組み込みのキーバリューストレージを使用して、プラグインの複数のインタラクション間でデータを保存します","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","description":"プラグイン manifest の YAML スキーマ。名前、作成者、ランタイム、リソース、権限、およびプラグインが提供するツール、モデル、エンドポイントを宣言します","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":"デプロイ","href":"/ja/self-host/deploy/overview"}]},{"tab":"使い方","icon":"book-open","pages":[{"title":"使い方","href":"/ja/self-host/use-dify/getting-started/introduction"}]},{"tab":"学習","icon":"graduation-cap","pages":[{"title":"学習","href":"/ja/learn/key-concepts"}]},{"tab":"開発者リソース","icon":"code","menu":[{"item":"API","icon":"code","pages":[{"title":"API","href":"/ja/api-reference/guides/get-started"}]},{"item":"CLI","icon":"terminal","pages":[{"title":"CLI","href":"/ja/cli/overview"}]},{"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":"永続ストレージ","description":"組み込みのキーバリューストレージを使用して、プラグインの複数のインタラクション間でデータを保存します","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","description":"プラグイン manifest の YAML スキーマ。名前、作成者、ランタイム、リソース、権限、およびプラグインが提供するツール、モデル、エンドポイントを宣言します","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"}]}]}]}]}]}]},"title":"ツールの戻り値 - Dify Docs","buildId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","deploymentId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","dynamics":[],"chunks":[]}