743 lines
120 KiB
HTML
743 lines
120 KiB
HTML
<!doctype html><script>(function(e,t,n,s,o){e[s]=e[s]||[],e[s].push({"gtm.start":(new Date).getTime(),event:"gtm.js"});var a=t.getElementsByTagName(n)[0],i=t.createElement(n),r=s!="dataLayer"?"&l="+s:"";i.async=!0,i.src="https://www.googletagmanager.com/gtm.js?id="+o+r,a.parentNode.insertBefore(i,a)})(window,document,"script","dataLayer","GTM-W9HPZZ22")</script><html lang=zh-cn><head><meta charset=utf-8><title>知识库接口 | FastGPT</title><meta name=viewport content="width=device-width,initial-scale=1"><meta name=description content="FastGPT OpenAPI 知识库接口"><meta name=keywords content="Documentation,Hugo,Hugo Theme,Bootstrap"><meta name=author content="Colin Wilson - Lotus Labs"><meta name=email content="support@aigis.uk"><meta name=website content="https://lotusdocs.dev"><meta name=Version content="v0.1.0"><link rel=icon href=https://doc.tryfastgpt.ai/favicon.ico sizes=any><link rel=icon type=image/svg+xml href=https://doc.tryfastgpt.ai/favicon.svg><link rel=apple-touch-icon sizes=180x180 href=https://doc.tryfastgpt.ai/apple-touch-icon.png><link rel=icon type=image/png sizes=32x32 href=https://doc.tryfastgpt.ai/favicon-32x32.png><link rel=icon type=image/png sizes=16x16 href=https://doc.tryfastgpt.ai/favicon-16x16.png><link rel=manifest crossorigin=use-credentials href=https://doc.tryfastgpt.ai/site.webmanifest><meta property="og:title" content="知识库接口"><meta property="og:description" content="FastGPT OpenAPI 知识库接口"><meta property="og:type" content="article"><meta property="og:url" content="https://doc.tryfastgpt.ai/docs/development/openapi/dataset/"><meta property="og:image" content="https://doc.tryfastgpt.ai/opengraph/card-base-2_hu06b1a92291a380a0d2e0ec03dab66b2f_17642_filter_9559675739756070563.png"><meta property="article:section" content="docs"><meta name=twitter:card content="summary_large_image"><meta name=twitter:image content="https://doc.tryfastgpt.ai/opengraph/card-base-2_hu06b1a92291a380a0d2e0ec03dab66b2f_17642_filter_9559675739756070563.png"><meta name=twitter:title content="知识库接口"><meta name=twitter:description content="FastGPT OpenAPI 知识库接口"><script>(()=>{var t=window.matchMedia&&window.matchMedia("(prefers-color-scheme: dark)").matches,e=localStorage.getItem("theme");t&&e===null&&(localStorage.setItem("theme","dark"),document.documentElement.setAttribute("data-dark-mode","")),t&&e==="dark"&&document.documentElement.setAttribute("data-dark-mode",""),e==="dark"&&document.documentElement.setAttribute("data-dark-mode","")})()</script><link rel=preconnect href=https://gstatic.loli.net/><link rel=preconnect href=https://gstatic.loli.net/ crossorigin><link href="https://fonts.loli.net/css?family=Inter:300,400,600,700|Fira+Code:500,700|JetBrains+Mono:500,700&display=block" rel=stylesheet><link rel=stylesheet href=/docs/scss/style.min.0ec826a837202d1bb0cc402457fc3b09de1d00673bd1fea8591ce85da15706ba66db8c4b0243747a2179524215798bcd.css integrity=sha384-DsgmqDcgLRuwzEAkV/w7Cd4dAGc70f6oWRzoXaFXBrpm24xLAkN0eiF5UkIVeYvN crossorigin=anonymous><script data-id=umami-script async src=https://umami.fastgpt.in/fastgpt data-website-id=69b3f2c6-39a5-4937-b92d-6fdd5c8f5958></script><script type=text/javascript>document.querySelector('script[data-id="umami-script"]').addEventListener("load",function(){const e=document.head.querySelector('meta[property = "og:type"]').getAttribute("content");let t=document.head.querySelector('meta[property = "og:title"]').getAttribute("content"),n=document.head.querySelector('meta[property = "og:url"]').getAttribute("content");umami.track(e+":"+t,{url:n})})</script><script defer>function loadAnalyticsScript(){var e=document.createElement("script");e.async=!0,e.src="https://gaxy.fastgpt.in/gtag/js?id=G-KGYF44Y7TT",document.head.appendChild(e),window.dataLayer=window.dataLayer||[];function t(){dataLayer.push(arguments)}t("js",new Date),t("config","G-KGYF44Y7TT"),window.removeEventListener("scroll",onScrollLoadAnalytics)}function onScrollLoadAnalytics(){window.scrollY>100&&loadAnalyticsScript()}window.addEventListener("scroll",onScrollLoadAnalytics)</script><script defer>function loadScriptOnScroll(){var e,t,n,s=window.scrollY||window.pageYOffset;s>100&&(n=n||[],e=document.createElement("script"),e.src="https://hm.baidu.com/hm.js?537c7867df8f9ae2e7147284ec0dbfdd",t=document.getElementsByTagName("script")[0],t.parentNode.insertBefore(e,t),window.removeEventListener("scroll",loadScriptOnScroll))}window.addEventListener("scroll",loadScriptOnScroll)</script><script defer>function loadClarityScript(){(function(e,t,n,s,o,i,a){e[n]=e[n]||function(){(e[n].q=e[n].q||[]).push(arguments)},i=t.createElement(s),i.async=1,i.src="https://www.clarity.ms/tag/"+o,a=t.getElementsByTagName(s)[0],a.parentNode.insertBefore(i,a)})(window,document,"clarity","script","mjgug8s1pf"),window.removeEventListener("scroll",onScrollLoadClarity)}function onScrollLoadClarity(){window.scrollY>100&&loadClarityScript()}window.addEventListener("scroll",onScrollLoadClarity)</script><link rel=preload href=https://cdn.jsdelivr.net/npm/lxgw-wenkai-screen-webfont@1.1.0/style.css as=style><link rel=stylesheet href=https://cdn.jsdelivr.net/npm/lxgw-wenkai-screen-webfont@1.1.0/style.css></head><body><noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-W9HPZZ22" height=0 width=0 style=display:none;visibility:hidden></iframe></noscript><div class=content><div class="page-wrapper toggled"><nav id=sidebar class=sidebar-wrapper><div class=sidebar-brand><a href=https://tryfastgpt.ai/ aria-label=HomePage alt=HomePage style=text-transform:unset><svg width="26" height="26" viewBox="0 0 1041 1348" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M340.837.33933 681.068.338989V.455643C684.032.378397 686.999.339702 689.967.339702 735.961.3397 781.504 9.62899 823.997 27.6772 866.49 45.7254 905.099 72.1791 937.622 105.528 970.144 138.877 995.942 178.467 1013.54 222.04 1031.14 265.612 1040.2 312.312 1040.2 359.474H340.836V1347.84C296.157 1347.84 251.914 1338.55 210.636 1320.49 169.357 1302.43 131.85 1275.95 100.257 1242.58 68.6636 1209.21 43.6023 1169.59 26.5041 1125.99 11.3834 1087.43 2.75216 1046.42.957956 1004.81H.605869L.605897 368.098H.70363c-.597878-26.267 1.53378-52.655 6.43943-78.687C20.2709 219.745 52.6748 155.754 100.257 105.528 147.839 55.3017 208.462 21.0975 274.461 7.24017 296.426 2.62833 318.657.339101 340.837.33933z" fill="url(#paint0_linear_1172_228)"/><path d="M633.639 904.645H513.029V576.37H635.422V576.377C678.161 576.607 720.454 585.093 759.951 601.37 799.997 617.874 836.384 642.064 867.033 672.559c30.65 30.495 54.963 66.698 71.55 106.542C955.171 818.944 963.709 861.648 963.709 904.775H633.639V904.645z" fill="url(#paint1_linear_1172_228)"/><defs><linearGradient id="paint0_linear_1172_228" x1="520.404" y1=".338989" x2="520.404" y2="1347.84" gradientUnits="userSpaceOnUse"><stop stop-color="#326dff"/><stop offset="1" stop-color="#8eaeff"/></linearGradient><linearGradient id="paint1_linear_1172_228" x1="738.369" y1="576.37" x2="738.369" y2="904.775" gradientUnits="userSpaceOnUse"><stop stop-color="#326dff"/><stop offset="1" stop-color="#8eaeff"/></linearGradient></defs></svg>
|
||
FastGPT</a></div><div class=sidebar-content style="height:calc(100% - 131px)"><ul class=sidebar-menu><li><a class=sidebar-root-link href=https://doc.tryfastgpt.ai/docs/intro/><i class="material-icons me-2">rocket_launch</i>
|
||
快速了解 FastGPT</a></li><li class=sidebar-dropdown><button class=btn>
|
||
<i class="material-icons me-2">import_contacts</i>
|
||
功能介绍</button><div class=sidebar-submenu><ul><li class="sidebar-dropdown nested"><button class=btn>
|
||
基础教程</button><div class=sidebar-submenu><ul><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/guide/course/quick-start/>快速上手</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/guide/course/ai_settings/>AI 相关参数配置说明</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/guide/course/chat_input_guide/>对话问题引导</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/guide/course/collection_tags/>知识库集合标签</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/guide/course/fileinput/>文件输入功能介绍</a></li></ul></div></li><li class="sidebar-dropdown nested"><button class=btn>
|
||
工作台</button><div class=sidebar-submenu><ul><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/guide/workbench/basic-mode/>简易模式</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/guide/workbench/intro/>工作流&插件</a></li><li class="sidebar-dropdown nested"><button class=btn>
|
||
工作流节点</button><div class=sidebar-submenu><ul><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/guide/workbench/workflow/ai_chat/>AI 对话</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/guide/workbench/workflow/dataset_search/>知识库搜索</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/guide/workbench/workflow/tool/>工具调用&终止</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/guide/workbench/workflow/question_classify/>问题分类</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/guide/workbench/workflow/content_extract/>文本内容提取</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/guide/workbench/workflow/user-selection/>用户选择</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/guide/workbench/workflow/form_input/>表单输入</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/guide/workbench/workflow/text_editor/>文本拼接</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/guide/workbench/workflow/reply/>指定回复</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/guide/workbench/workflow/document_parsing/>文档解析</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/guide/workbench/workflow/http/>HTTP 请求</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/guide/workbench/workflow/tfswitch/>判断器</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/guide/workbench/workflow/variable_update/>变量更新</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/guide/workbench/workflow/sandbox/>代码运行</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/guide/workbench/workflow/loop/>批量运行</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/guide/workbench/workflow/knowledge_base_search_merge/>知识库搜索引用合并</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/guide/workbench/workflow/coreferenceresolution/>问题优化</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/guide/workbench/workflow/laf/>Laf 函数调用</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/guide/workbench/workflow/custom_feedback/>自定义反馈</a></li></ul></div></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/guide/workbench/gapier/>使用 Gapier 快速导入Agent工具</a></li></ul></div></li><li class="sidebar-dropdown nested"><button class=btn>
|
||
系统插件</button><div class=sidebar-submenu><ul><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/guide/plugins/how_to_submit_system_plugin/>如何提交系统插件</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/guide/plugins/searxng_plugin_guide/>SearXNG 搜索插件配置与使用说明</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/guide/plugins/google_search_plugin_guide/>Google 搜索插件填写说明</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/guide/plugins/bing_search_plugin/>Bing 搜索插件填写说明</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/guide/plugins/doc2x_plugin_guide/>Doc2x 插件填写说明</a></li></ul></div></li><li class="sidebar-dropdown nested"><button class=btn>
|
||
知识库</button><div class=sidebar-submenu><ul><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/guide/knowledge_base/rag/>知识库基础原理介绍</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/guide/knowledge_base/dataset_engine/>知识库搜索方案和参数</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/guide/knowledge_base/api_dataset/>API 文件库</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/guide/knowledge_base/lark_dataset/>飞书知识库</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/guide/knowledge_base/yuque_dataset/>语雀文件库</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/guide/knowledge_base/websync/>Web 站点同步</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/guide/knowledge_base/externalfile/>外部文件知识库</a></li></ul></div></li><li class="sidebar-dropdown nested"><button class=btn>
|
||
团队与权限</button><div class=sidebar-submenu><ul><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/guide/team_permissions/team_roles_permissions/>团队&成员组&权限</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/guide/team_permissions/invitation_link/>邀请链接说明文档</a></li></ul></div></li><li class="sidebar-dropdown nested"><button class=btn>
|
||
对话框</button><div class=sidebar-submenu><ul><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/guide/dialogboxes/htmlrendering/>对话框与HTML渲染</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/guide/dialogboxes/quotelist/>知识库引用分块阅读器</a></li></ul></div></li><li class="sidebar-dropdown nested"><button class=btn>
|
||
商业版后台</button><div class=sidebar-submenu><ul><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/guide/admin/sso/>SSO & 外部成员同步</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/guide/admin/teammode/>团队模式说明文档</a></li></ul></div></li></ul></div></li><li class=sidebar-dropdown><button class=btn>
|
||
<i class="material-icons me-2">cases</i>
|
||
使用案例</button><div class=sidebar-submenu><ul><li class="sidebar-dropdown nested"><button class=btn>
|
||
外部调用 FastGPT</button><div class=sidebar-submenu><ul><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/use-cases/external-integration/openapi/>通过 API 访问应用</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/use-cases/external-integration/feishu/>接入飞书机器人教程</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/use-cases/external-integration/dingtalk/>接入钉钉机器人教程</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/use-cases/external-integration/official_account/>接入微信公众号教程</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/use-cases/external-integration/onwechat/>对接 chatgpt-on-wechat</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/use-cases/external-integration/wechat/>接入微信和企业微信</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/use-cases/external-integration/iframe_integration/>iframe 接入</a></li></ul></div></li><li class="sidebar-dropdown nested"><button class=btn>
|
||
应用搭建案例</button><div class=sidebar-submenu><ul><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/use-cases/app-cases/submit_application_template/>如何提交应用模板</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/use-cases/app-cases/translate-subtitle-using-gpt/>长字幕翻译</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/use-cases/app-cases/multi_turn_translation_bot/>多轮翻译机器人</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/use-cases/app-cases/english_essay_correction_bot/>英语作文纠错机器人</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/use-cases/app-cases/fixingevidence/>固定开头和结尾内容</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/use-cases/app-cases/lab_appointment/>实验室预约</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/use-cases/app-cases/dalle3/>Dalle3 绘图</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/use-cases/app-cases/google_search/>接入谷歌搜索</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/use-cases/app-cases/feishu_webhook/>发送飞书webhook通知</a></li></ul></div></li></ul></div></li><li class="sidebar-dropdown current active"><button class=btn>
|
||
<i class="material-icons me-2">code_blocks</i>
|
||
开发与部署指南</button><div class="sidebar-submenu d-block"><ul><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/intro/>快速开始本地开发</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/sealos/>Sealos 一键部署</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/docker/>Docker Compose 快速部署</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/configuration/>配置文件介绍</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/faq/>私有部署常见问题</a></li><li class="sidebar-dropdown nested"><button class=btn>
|
||
模型配置方案</button><div class=sidebar-submenu><ul><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/modelconfig/intro/>FastGPT 模型配置说明</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/modelconfig/ai-proxy/>通过 AI Proxy 接入模型</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/modelconfig/one-api/>通过 OneAPI 接入模型</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/modelconfig/siliconcloud/>通过 SiliconCloud 体验开源模型</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/modelconfig/ppio/>通过 PPIO LLM API 接入模型</a></li></ul></div></li><li class="sidebar-dropdown nested"><button class=btn>
|
||
版本更新/升级操作</button><div class=sidebar-submenu><ul><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/upgrading/intro/>升级说明</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/upgrading/494/>V4.9.4(进行中)</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/upgrading/493/>V4.9.3</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/upgrading/492/>V4.9.2</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/upgrading/491/>V4.9.1</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/upgrading/490/>V4.9.0(包含升级脚本)</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/upgrading/4823/>V4.8.23</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/upgrading/4822/>V4.8.22(包含升级脚本)</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/upgrading/4821/>V4.8.21</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/upgrading/4820/>V4.8.20(包含升级脚本)</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/upgrading/4819/>V4.8.19(包含升级脚本)</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/upgrading/4818/>V4.8.18(包含升级脚本)</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/upgrading/4817/>V4.8.17(包含升级脚本)</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/upgrading/4816/>V4.8.16(更新配置文件)</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/upgrading/4815/>V4.8.15(包含升级脚本)</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/upgrading/4814/>V4.8.14</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/upgrading/4813/>V4.8.13</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/upgrading/4812/>V4.8.12(包含升级脚本)</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/upgrading/4811/>V4.8.11（商业版初始化）</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/upgrading/4810/>V4.8.10(包含升级脚本)</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/upgrading/489/>V4.8.9（需要初始化）</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/upgrading/488/>V4.8.8(包含升级脚本)</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/upgrading/487/>V4.8.7</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/upgrading/486/>V4.8.6(包含升级脚本)</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/upgrading/485/>V4.8.5(包含升级脚本)</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/upgrading/484/>V4.8.4(包含升级脚本)</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/upgrading/483/>V4.8.3</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/upgrading/482/>V4.8.2</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/upgrading/481/>V4.8.1(包含升级脚本)</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/upgrading/48/>V4.8</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/upgrading/471/>V4.7.1(包含升级脚本)</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/upgrading/47/>V4.7（需要初始化）</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/upgrading/469/>V4.6.9(包含升级脚本)</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/upgrading/468/>V4.6.8（需要初始化）</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/upgrading/467/>V4.6.7（需要初始化）</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/upgrading/466/>V4.6.6（需要改配置文件）</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/upgrading/465/>V4.6.5（需要改配置文件）</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/upgrading/464/>V4.6.4(包含升级脚本)</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/upgrading/463/>V4.6.3(包含升级脚本)</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/upgrading/462/>V4.6.2(包含升级脚本)</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/upgrading/461/>V4.6.1</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/upgrading/46/>V4.6(包含升级脚本)</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/upgrading/452/>V4.5.2</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/upgrading/451/>V4.5.1(需进行初始化)</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/upgrading/45/>V4.5(需进行较为复杂更新)</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/upgrading/447/>V4.4.7（需执行升级脚本）</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/upgrading/446/>V4.4.6</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/upgrading/445/>V4.4.5(包含升级脚本)</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/upgrading/442/>升级到 V4.4.2(包含升级脚本)</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/upgrading/441/>升级到 V4.4.1(包含升级脚本)</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/upgrading/44/>升级到 V4.4(包含升级脚本)</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/upgrading/43/>升级到 V4.3(包含升级脚本)</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/upgrading/421/>升级到 V4.2.1</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/upgrading/42/>升级到 V4.2</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/upgrading/41/>升级到 V4.1</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/upgrading/40/>升级到 V4.0</a></li></ul></div></li><li class="sidebar-dropdown nested current active"><button class=btn>
|
||
OpenAPI 接口文档</button><div class="sidebar-submenu d-block"><ul><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/openapi/intro/>OpenAPI 介绍</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/openapi/chat/>对话接口</a></li><li class=current><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/openapi/dataset/>知识库接口</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/openapi/share/>分享链接身份鉴权</a></li></ul></div></li><li class="sidebar-dropdown nested"><button class=btn>
|
||
本地模型使用</button><div class=sidebar-submenu><ul><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/custom-models/marker/>接入 Marker PDF 文档解析</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/custom-models/xinference/>使用 Xinference 接入本地模型</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/custom-models/bge-rerank/>接入 bge-rerank 重排模型</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/custom-models/chatglm2/>接入 ChatGLM2-6B</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/custom-models/m3e/>接入 M3E 向量模型</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/custom-models/chatglm2-m3e/>接入 ChatGLM2-m3e 模型</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/custom-models/ollama/>使用 Ollama 接入本地模型</a></li></ul></div></li><li class="sidebar-dropdown nested"><button class=btn>
|
||
代理方案</button><div class=sidebar-submenu><ul><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/proxy/nginx/>Nginx 中转</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/proxy/http_proxy/>HTTP 代理中转</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/proxy/cloudflare/>Cloudflare Worker 中转</a></li></ul></div></li><li class="sidebar-dropdown nested"><button class=btn>
|
||
迁移&备份</button><div class=sidebar-submenu><ul><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/migration/docker_mongo/>Docker Mongo迁移(dump模式)</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/migration/docker_db/>Docker 数据库迁移(无脑操作)</a></li></ul></div></li><li class="sidebar-dropdown nested"><button class=btn>
|
||
设计方案</button><div class=sidebar-submenu><ul><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/development/design/dataset/>数据集</a></li></ul></div></li></ul></div></li><li class=sidebar-dropdown><button class=btn>
|
||
<i class="material-icons me-2">quiz</i>
|
||
FAQ</button><div class=sidebar-submenu><ul><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/faq/docker/>Docker 部署问题</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/faq/privatedeploy/>私有部署常见问题</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/faq/chat/>聊天框问题</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/faq/app/>应用使用问题</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/faq/dataset/>知识库使用问题</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/faq/external_channel_integration/>接入外部渠道</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/faq/error/>报错</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/faq/points_consumption/>积分消耗</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/faq/other/>其他问题</a></li></ul></div></li><li class=sidebar-dropdown><button class=btn>
|
||
<i class="material-icons me-2">shopping_cart</i>
|
||
收费说明</button><div class=sidebar-submenu><ul><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/shopping_cart/saas/>线上版定价</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/shopping_cart/intro/>商业版</a></li></ul></div></li><li class=sidebar-dropdown><button class=btn>
|
||
<i class="material-icons me-2">handshake</i>
|
||
协议</button><div class=sidebar-submenu><ul><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/agreement/open-source/>开源协议</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/agreement/terms/>服务协议</a></li><li><a class=sidebar-nested-link href=https://doc.tryfastgpt.ai/docs/agreement/privacy/>隐私政策</a></li></ul></div></li><li><a class=sidebar-root-link href=https://doc.tryfastgpt.ai/docs/community/><i class="material-icons me-2">forum</i>
|
||
加入社区</a></li></ul></div><ul class="sidebar-footer list-unstyled mb-0"></ul></nav><main class="page-content bg-transparent"><div id=top-header class="top-header d-print-none"><div class="header-bar d-flex justify-content-between"><div class="d-flex align-items-center"><a href=https://tryfastgpt.ai/ class="logo-icon me-3" aria-label=HomePage alt=HomePage><div class=small><svg width="26" height="26" viewBox="0 0 1041 1348" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M340.837.33933 681.068.338989V.455643C684.032.378397 686.999.339702 689.967.339702 735.961.3397 781.504 9.62899 823.997 27.6772 866.49 45.7254 905.099 72.1791 937.622 105.528 970.144 138.877 995.942 178.467 1013.54 222.04 1031.14 265.612 1040.2 312.312 1040.2 359.474H340.836V1347.84C296.157 1347.84 251.914 1338.55 210.636 1320.49 169.357 1302.43 131.85 1275.95 100.257 1242.58 68.6636 1209.21 43.6023 1169.59 26.5041 1125.99 11.3834 1087.43 2.75216 1046.42.957956 1004.81H.605869L.605897 368.098H.70363c-.597878-26.267 1.53378-52.655 6.43943-78.687C20.2709 219.745 52.6748 155.754 100.257 105.528 147.839 55.3017 208.462 21.0975 274.461 7.24017 296.426 2.62833 318.657.339101 340.837.33933z" fill="url(#paint0_linear_1172_228)"/><path d="M633.639 904.645H513.029V576.37H635.422V576.377C678.161 576.607 720.454 585.093 759.951 601.37 799.997 617.874 836.384 642.064 867.033 672.559c30.65 30.495 54.963 66.698 71.55 106.542C955.171 818.944 963.709 861.648 963.709 904.775H633.639V904.645z" fill="url(#paint1_linear_1172_228)"/><defs><linearGradient id="paint0_linear_1172_228" x1="520.404" y1=".338989" x2="520.404" y2="1347.84" gradientUnits="userSpaceOnUse"><stop stop-color="#326dff"/><stop offset="1" stop-color="#8eaeff"/></linearGradient><linearGradient id="paint1_linear_1172_228" x1="738.369" y1="576.37" x2="738.369" y2="904.775" gradientUnits="userSpaceOnUse"><stop stop-color="#326dff"/><stop offset="1" stop-color="#8eaeff"/></linearGradient></defs></svg></div><div class=big><svg width="26" height="26" viewBox="0 0 1041 1348" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M340.837.33933 681.068.338989V.455643C684.032.378397 686.999.339702 689.967.339702 735.961.3397 781.504 9.62899 823.997 27.6772 866.49 45.7254 905.099 72.1791 937.622 105.528 970.144 138.877 995.942 178.467 1013.54 222.04 1031.14 265.612 1040.2 312.312 1040.2 359.474H340.836V1347.84C296.157 1347.84 251.914 1338.55 210.636 1320.49 169.357 1302.43 131.85 1275.95 100.257 1242.58 68.6636 1209.21 43.6023 1169.59 26.5041 1125.99 11.3834 1087.43 2.75216 1046.42.957956 1004.81H.605869L.605897 368.098H.70363c-.597878-26.267 1.53378-52.655 6.43943-78.687C20.2709 219.745 52.6748 155.754 100.257 105.528 147.839 55.3017 208.462 21.0975 274.461 7.24017 296.426 2.62833 318.657.339101 340.837.33933z" fill="url(#paint0_linear_1172_228)"/><path d="M633.639 904.645H513.029V576.37H635.422V576.377C678.161 576.607 720.454 585.093 759.951 601.37 799.997 617.874 836.384 642.064 867.033 672.559c30.65 30.495 54.963 66.698 71.55 106.542C955.171 818.944 963.709 861.648 963.709 904.775H633.639V904.645z" fill="url(#paint1_linear_1172_228)"/><defs><linearGradient id="paint0_linear_1172_228" x1="520.404" y1=".338989" x2="520.404" y2="1347.84" gradientUnits="userSpaceOnUse"><stop stop-color="#326dff"/><stop offset="1" stop-color="#8eaeff"/></linearGradient><linearGradient id="paint1_linear_1172_228" x1="738.369" y1="576.37" x2="738.369" y2="904.775" gradientUnits="userSpaceOnUse"><stop stop-color="#326dff"/><stop offset="1" stop-color="#8eaeff"/></linearGradient></defs></svg></div></a><button id=close-sidebar class="btn btn-icon btn-soft">
|
||
<span class="material-icons size-20 menu-icon align-middle">menu</span></button>
|
||
<span><div id=docsearch></div></span></div><div class="d-flex align-items-center"><ul class="list-unstyled mb-0"><li class="list-inline-item mb-0"><a href=https://github.com/labring/FastGPT alt=github rel="noopener noreferrer" target=_blank><div class="btn btn-icon btn-default border-0"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><title>GitHub</title><path d="M9 19c-5 1.5-5-2.5-7-3m14 6v-3.87a3.37 3.37.0 00-.94-2.61c3.14-.35 6.44-1.54 6.44-7A5.44 5.44.0 0020 4.77 5.07 5.07.0 0019.91 1S18.73.65 16 2.48a13.38 13.38.0 00-7 0C6.27.65 5.09 1 5.09 1A5.07 5.07.0 005 4.77 5.44 5.44.0 003.5 8.55c0 5.42 3.3 6.61 6.44 7A3.37 3.37.0 009 18.13V22"/></svg></div></a></li><li class="list-inline-item mb-0"><a href=https://oss.laf.run/htr4n1-images/fastgpt-qr-code.jpg alt=wechat rel="noopener noreferrer" target=_blank><div class="btn btn-icon btn-default border-0"><svg xmlns="http://www.w3.org/2000/svg" width="28" height="28" viewBox="0 0 28 28" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><title>微信群</title><path d="M21.6696 15.9962C21.9464 15.9925 22.2107 15.881 22.4064 15.6853 22.6021 15.4896 22.7137 15.2252 22.7173 14.9485c0-.581-.465500000000002-1.0477-1.0477-1.0477C21.0875 13.9008 20.622 14.3675 20.622 14.9485c0 .583300000000001.4666 1.0477 1.0476 1.0477zm-5.1625.0C16.7839 15.9925 17.0482 15.881 17.2439 15.6853S17.5512 15.2252 17.5548 14.9485c0-.581-.466699999999999-1.0477-1.0477-1.0477C15.9238 13.9008 15.4595 14.3675 15.4595 14.9485c0 .583300000000001.4655 1.0477 1.0476 1.0477zm7.6615 5.88C24.0939 21.9177 24.0342 21.9818 23.9981 22.0594 23.9621 22.1369 23.9515 22.2239 23.968 22.3078 23.968 22.3638 23.968 22.421 23.9971 22.4793c.1144.486500000000003.343 1.2612.343 1.2904C24.3401 23.8548 24.3693 23.912 24.3693 23.9703 24.3693 24.0041 24.3626 24.0376 24.3496 24.0688 24.3367 24.1 24.3177 24.1284 24.2937 24.1522 24.2697 24.1761 24.2413 24.195 24.21 24.2078 24.1788 24.2206 24.1453 24.2272 24.1115 24.227 24.0531 24.227 24.0251 24.199 23.968 24.171L22.2775 23.1957C22.154 23.1277 22.0168 23.0886 21.8761 23.0813 21.791 23.0813 21.7046 23.0813 21.6475 23.1093 20.8448 23.3392 20.0141 23.4535 19.1263 23.4535c-4.27.0-7.7082-2.8665-7.7082-6.4225.0-3.5548 3.4382-6.4225 7.7082-6.4225 4.2688.0 7.707 2.8677 7.707 6.4225.0 1.9215-1.0313 3.6703-2.6647 4.8463V21.8762zM19.4518 9.44883C19.3429 9.44521 19.234 9.44327 19.1251 9.443c-4.8696.0-8.8736 3.3367-8.8736 7.5892.0.6463.0932999999999993 1.2716.266 1.8666H10.4136C9.39426 18.8885 8.38067 18.7442 7.39896 18.4695 7.31263 18.4403 7.22629 18.4403 7.13996 18.4403 6.96754 18.444 6.79921 18.4935 6.65229 18.5838L4.61296 19.7563C4.55463 19.7855 4.49746 19.8147 4.44029 19.8147 4.35703 19.8138 4.27744 19.7803 4.21856 19.7214 4.15968 19.6625 4.1262 19.5829 4.12529 19.4997 4.12529 19.4133 4.15329 19.3562 4.18246 19.2698 4.21046 19.2418 4.46946 18.2968 4.61296 17.7252 4.61296 17.6668 4.64096 17.5817 4.64096 17.5245 4.64065 17.4245 4.61721 17.3259 4.57248 17.2364 4.52775 17.147 4.46295 17.0691 4.38313 17.0088c-1.98217-1.4035-3.2165-3.4918-3.2165-5.8111.0-4.26187 4.165-7.6977 9.27497-7.6977 4.3925.0 8.085 2.5305 9.0102 5.94767V9.44883zM13.4388 9.9365c.6685.0 1.197-.5565 1.197-1.197.0-.6685-.528499999999999-1.197-1.197-1.197S12.2418 8.071 12.2418 8.7395 12.7703 9.9365 13.4388 9.9365zm-6.13667.0c.6685.0 1.19816-.5565 1.19816-1.197.0-.6685-.52966-1.197-1.19816-1.197-.66734.0-1.197.528499999999999-1.197 1.197s.52966 1.197 1.197 1.197z"/></svg></div></a></li><li class="list-inline-item mb-0"><a href=https://oss.laf.run/otnvvf-imgs/fastgpt-feishu1.png alt=lark rel="noopener noreferrer" target=_blank><div class="btn btn-icon btn-default border-0"><svg t="1728884315234" class="icon" viewBox="0 0 1224 1024" xmlns="http://www.w3.org/2000/svg" p-id="4847" width="28" height="28" fill="currentcolor"><path d="M1224.146926 401.768509a50.444385 50.444385.0 00-23.813954-38.631991c-6.095363-3.741292-61.752335-36.782364-141.475481-43.949671A317.253146 317.253146.0 00922.972928 336.16979L746.964061 25.579507A50.444385 50.444385.0 00703.077446.0H284.809419A50.444385 50.444385.0 00248.027055 84.97777c3.236848 3.447033 296.360763 315.739814 426.969683 459.653442-59.734559 55.762064-103.558119 83.800735-127.666331 96.832201L346.435643 500.639504a50.045034 50.045034.0 00-6.97814-4.098606L79.416697 314.205464A50.444385 50.444385.0 00.744475 364.124387c.210185 1.177036 20.619142 118.607361 42.036988 237.635091 44.033744 245.538045 48.994109 257.896919 52.272994 266.11515 5.065457 12.611096 14.334613 24.549601 44.895503 44.538188a595.916337 595.916337.0 0069.361029 38.337733c49.519571 23.603769 128.212812 54.437899 221.59798 67.25918a623.009175 623.009175.0 0085.061845 5.948234c131.491697.0 290.055215-44.138837 418.373119-211.404011 73.564728-96.054517 118.250046-163.944252 154.086578-218.592335 44.033745-67.070014 70.622139-107.551633 118.838564-150.177139a50.444385 50.444385.0 0016.877851-42.015969zM673.693591 100.88877 834.443032 384.638437a413.097477 413.097477.0 00-63.055481 59.356226c-8.743693 10.04684-17.256183 19.568218-25.579507 28.711263-89.559802-98.744884-248.774893-269.373017-344.619225-371.817156zM305.491617 882.125167c-59.86067-22.594881-102.065806-47.85911-118.523287-59.692523-10.299062-45.610132-39.935138-209.638457-65.829922-355.780044l391.238243 274.270325a48.132351 48.132351.0 006.725918 3.951477l189.166445 132.689752A398.300458 398.300458.0 01552.85827 921.702991c-97.336645 7.713787-188.262649-17.277202-247.366653-39.577824zm698.654734-343.442189c-34.932737 53.197808-78.398982 119.385045-149.819824 212.496972a503.371908 503.371908.0 01-58.641598 64.33761L637.499745 704.687042c35.31107-23.813953 81.152405-60.070855 135.905581-114.803013a48.342536 48.342536.0 0014.944149-15.154334c18.790533-19.379051 38.568936-40.859952 59.272153-64.694924 57.086229-65.745849 124.009113-96.243683 198.540692-90.673782a247.639894 247.639894.0 0138.589955 6.011289c-28.290893 33.62959-51.936698 69.63427-80.605924 113.3107z" p-id="4848"/></svg></div></a></li></ul><button id=mode class="btn btn-icon btn-default ms-2" type=button aria-label="Toggle user interface mode">
|
||
<span class=toggle-dark><svg xmlns="http://www.w3.org/2000/svg" height="30" width="30" viewBox="0 0 48 48" fill="currentcolor"><path d="M24 42q-7.5.0-12.75-5.25T6 24t5.25-12.75T24 6q.4.0.85.025.45.025 1.15.075-1.8 1.6-2.8 3.95t-1 4.95q0 4.5 3.15 7.65Q28.5 25.8 33 25.8q2.6.0 4.95-.925T41.9 22.3q.05.6.075.975Q42 23.65 42 24q0 7.5-5.25 12.75T24 42zm0-3q5.45.0 9.5-3.375t5.05-7.925q-1.25.55-2.675.825Q34.45 28.8 33 28.8q-5.75.0-9.775-4.025T19.2 15q0-1.2.25-2.575t.9-3.125q-4.9 1.35-8.125 5.475Q9 18.9 9 24q0 6.25 4.375 10.625T24 39zm-.2-14.85z"/></svg></span><span class=toggle-light><svg xmlns="http://www.w3.org/2000/svg" height="30" width="30" viewBox="0 0 48 48" fill="currentcolor"><path d="M24 31q2.9.0 4.95-2.05T31 24t-2.05-4.95T24 17t-4.95 2.05T17 24t2.05 4.95T24 31zm0 3q-4.15.0-7.075-2.925T14 24t2.925-7.075T24 14t7.075 2.925T34 24t-2.925 7.075T24 34zM3.5 25.5q-.65.0-1.075-.425Q2 24.65 2 24t.425-1.075Q2.85 22.5 3.5 22.5h5q.65.0 1.075.425Q10 23.35 10 24t-.425 1.075T8.5 25.5zm36 0q-.65.0-1.075-.425Q38 24.65 38 24t.425-1.075T39.5 22.5h5q.65.0 1.075.425Q46 23.35 46 24t-.425 1.075-1.075.425zM24 10q-.65.0-1.075-.425Q22.5 9.15 22.5 8.5v-5q0-.65.425-1.075Q23.35 2 24 2t1.075.425T25.5 3.5v5q0 .65-.425 1.075Q24.65 10 24 10zm0 36q-.65.0-1.075-.425T22.5 44.5v-5q0-.65.425-1.075Q23.35 38 24 38t1.075.425.425 1.075v5q0 .65-.425 1.075Q24.65 46 24 46zM12 14.1l-2.85-2.8q-.45-.45-.425-1.075.025-.625.425-1.075.45-.45 1.075-.45t1.075.45L14.1 12q.4.45.4 1.05.0.6-.4 1-.4.45-1.025.45T12 14.1zm24.7 24.75L33.9 36q-.4-.45-.4-1.075t.45-1.025q.4-.45 1-.45t1.05.45l2.85 2.8q.45.45.425 1.075-.025.625-.425 1.075-.45.45-1.075.45t-1.075-.45zM33.9 14.1q-.45-.45-.45-1.05.0-.6.45-1.05l2.8-2.85q.45-.45 1.075-.425.625.025 1.075.425.45.45.45 1.075t-.45 1.075L36 14.1q-.4.4-1.025.4t-1.075-.4zM9.15 38.85q-.45-.45-.45-1.075t.45-1.075L12 33.9q.45-.45 1.05-.45.6.0 1.05.45.45.45.45 1.05.0.6-.45 1.05l-2.8 2.85q-.45.45-1.075.425-.625-.025-1.075-.425zM24 24z"/></svg></span></button></div></div></div><div class=container-fluid><div class=layout-spacing><div class="d-md-flex justify-content-between align-items-center"><nav aria-label=breadcrumb class="d-inline-block pb-2 mt-1 mt-sm-0"><ul id=breadcrumbs class="breadcrumb bg-transparent mb-0" itemscope itemtype=https://schema.org/BreadcrumbList><li class="breadcrumb-item text-capitalize active" aria-current=page itemprop=itemListElement itemscope itemtype=https://schema.org/ListItem><a itemprop=item href=/docs/><i class="material-icons size-20 align-text-bottom" itemprop=name>Home</i></a><meta itemprop=position content="1"></li><li class="breadcrumb-item text-capitalize" itemprop=itemListElement itemscope itemtype=https://schema.org/ListItem><a itemprop=item href=/docs/development/><span itemprop=name>开发与部署指南</span></a><meta itemprop=position content="2"></li><li class="breadcrumb-item text-capitalize" itemprop=itemListElement itemscope itemtype=https://schema.org/ListItem><a itemprop=item href=/docs/development/openapi/><span itemprop=name>OpenAPI 接口文档</span></a><meta itemprop=position content="3"></li><li class="breadcrumb-item text-capitalize active" itemprop=itemListElement itemscope itemtype=https://schema.org/ListItem><span itemprop=name>知识库接口</span><meta itemprop=position content="4"></li></ul></nav></div><div class="row flex-xl-nowrap"><div class="docs-toc col-xl-3 d-xl-block"><toc><div class="fw-bold text-uppercase mb-2">知识库接口</div><nav id=toc><ul><li><ul><li><a href=#创建训练订单>创建训练订单</a></li><li><a href=#知识库>知识库</a><ul><li><a href=#创建一个知识库>创建一个知识库</a></li><li><a href=#获取知识库列表>获取知识库列表</a></li><li><a href=#获取知识库详情>获取知识库详情</a></li><li><a href=#删除一个知识库>删除一个知识库</a></li></ul></li><li><a href=#集合>集合</a><ul><li><a href=#通用创建参数说明必看>通用创建参数说明（必看）</a></li><li><a href=#创建一个空的集合>创建一个空的集合</a></li><li><a href=#创建一个纯文本集合>创建一个纯文本集合</a></li><li><a href=#创建一个链接集合>创建一个链接集合</a></li><li><a href=#创建一个文件集合>创建一个文件集合</a></li><li><a href=#创建一个api集合>创建一个API集合</a></li><li><a href=#创建一个外部文件库集合商业版>创建一个外部文件库集合（商业版）</a></li><li><a href=#获取集合列表>获取集合列表</a></li><li><a href=#获取集合详情>获取集合详情</a></li><li><a href=#修改集合信息>修改集合信息</a></li><li><a href=#删除一个集合>删除一个集合</a></li></ul></li><li><a href=#数据>数据</a><ul><li><a href=#数据的结构>数据的结构</a></li><li><a href=#为集合批量添加添加数据>为集合批量添加添加数据</a></li><li><a href=#获取集合的数据列表>获取集合的数据列表</a></li><li><a href=#获取单条数据详情>获取单条数据详情</a></li><li><a href=#修改单条数据>修改单条数据</a></li><li><a href=#删除单条数据>删除单条数据</a></li></ul></li><li><a href=#搜索测试>搜索测试</a></li></ul></li></ul></nav></toc></div><div class="docs-toc-mobile d-print-none d-xl-none"><button id=toc-dropdown-btn class="btn-secondary dropdown-toggle" type=button data-bs-toggle=dropdown data-bs-offset=0,0 aria-expanded=false>
|
||
Table of Contents</button><nav id=toc-mobile><ul class=dropdown-menu><li><ul><li><a href=#创建训练订单>创建训练订单</a></li><li><a href=#知识库>知识库</a><ul><li><a href=#创建一个知识库>创建一个知识库</a></li><li><a href=#获取知识库列表>获取知识库列表</a></li><li><a href=#获取知识库详情>获取知识库详情</a></li><li><a href=#删除一个知识库>删除一个知识库</a></li></ul></li><li><a href=#集合>集合</a><ul><li><a href=#通用创建参数说明必看>通用创建参数说明（必看）</a></li><li><a href=#创建一个空的集合>创建一个空的集合</a></li><li><a href=#创建一个纯文本集合>创建一个纯文本集合</a></li><li><a href=#创建一个链接集合>创建一个链接集合</a></li><li><a href=#创建一个文件集合>创建一个文件集合</a></li><li><a href=#创建一个api集合>创建一个API集合</a></li><li><a href=#创建一个外部文件库集合商业版>创建一个外部文件库集合（商业版）</a></li><li><a href=#获取集合列表>获取集合列表</a></li><li><a href=#获取集合详情>获取集合详情</a></li><li><a href=#修改集合信息>修改集合信息</a></li><li><a href=#删除一个集合>删除一个集合</a></li></ul></li><li><a href=#数据>数据</a><ul><li><a href=#数据的结构>数据的结构</a></li><li><a href=#为集合批量添加添加数据>为集合批量添加添加数据</a></li><li><a href=#获取集合的数据列表>获取集合的数据列表</a></li><li><a href=#获取单条数据详情>获取单条数据详情</a></li><li><a href=#修改单条数据>修改单条数据</a></li><li><a href=#删除单条数据>删除单条数据</a></li></ul></li><li><a href=#搜索测试>搜索测试</a></li></ul></li></ul></nav></div><div class="docs-content col-12 col-xl-9 mt-0"><div class="mb-0 d-flex"><i class="material-icons title-icon me-2">dataset</i><h1 class="content-title mb-0">知识库接口</h1></div><p class="lead mb-3">FastGPT OpenAPI 知识库接口</p><div id=content class=main-content data-bs-spy=scroll data-bs-root-margin="0px 0px -65%" data-bs-target=#toc-mobile><div data-prismjs-copy data-prismjs-copy-success data-prismjs-copy-error><table><thead><tr><th>如何获取知识库ID（datasetId）</th><th>如何获取文件集合ID（collection_id）</th></tr></thead><tbody><tr><td><img src=https://cdn.jsdelivr.net/gh/yangchuansheng/fastgpt-imgs@main/imgs/getDatasetId.jpg alt loading=lazy class=medium-zoom-image></td><td><img src=https://cdn.jsdelivr.net/gh/yangchuansheng/fastgpt-imgs@main/imgs/getfile_id.webp alt loading=lazy class=medium-zoom-image></td></tr></tbody></table><h2 id=创建训练订单>创建训练订单 <a href=#%e5%88%9b%e5%bb%ba%e8%ae%ad%e7%bb%83%e8%ae%a2%e5%8d%95 class=anchor aria-hidden=true><i class="material-icons align-middle">link</i></a></h2><nav><div class="nav nav-tabs" id=nav-tab role=tablist><a class="nav-link active" id=daefbcTab data-bs-toggle=tab data-bs-target=#daefbc type=button role=tab aria-controls=daefbc aria-selected=true>请求示例</a>
|
||
<a class=nav-link id=ebfcdaTab data-bs-toggle=tab data-bs-target=#ebfcda type=button role=tab aria-controls=ebfcda aria-selected=true>响应示例</a></div></nav><div class=tab-content id=nav-tab-content><div class="tab-pane fade show active" id=daefbc role=tabpanel aria-labelledby=nav-1><p><strong>新例子</strong></p><div class=prism-codeblock><pre id=555866f class=language-bash>
|
||
<code>curl --location --request POST 'http://localhost:3000/api/support/wallet/usage/createTrainingUsage' \
|
||
--header 'Authorization: Bearer {{apikey}}' \
|
||
--header 'Content-Type: application/json' \
|
||
--data-raw '{
|
||
"datasetId": "知识库 ID",
|
||
"name": "可选，自定义订单名称，例如：文档训练-fastgpt.docx"
|
||
}'</code>
|
||
</pre></div></div><div class="tab-pane fade" id=ebfcda role=tabpanel aria-labelledby=nav-1><p>data 为 billId，可用于添加知识库数据时进行账单聚合。</p><div class=prism-codeblock><pre id=a6c5f71 class=language-json>
|
||
<code>{
|
||
"code": 200,
|
||
"statusText": "",
|
||
"message": "",
|
||
"data": "65112ab717c32018f4156361"
|
||
}</code>
|
||
</pre></div></div></div><h2 id=知识库>知识库 <a href=#%e7%9f%a5%e8%af%86%e5%ba%93 class=anchor aria-hidden=true><i class="material-icons align-middle">link</i></a></h2><h3 id=创建一个知识库>创建一个知识库 <a href=#%e5%88%9b%e5%bb%ba%e4%b8%80%e4%b8%aa%e7%9f%a5%e8%af%86%e5%ba%93 class=anchor aria-hidden=true><i class="material-icons align-middle">link</i></a></h3><nav><div class="nav nav-tabs" id=nav-tab role=tablist><a class="nav-link active" id=cafedbTab data-bs-toggle=tab data-bs-target=#cafedb type=button role=tab aria-controls=cafedb aria-selected=true>请求示例</a>
|
||
<a class=nav-link id=dcbafeTab data-bs-toggle=tab data-bs-target=#dcbafe type=button role=tab aria-controls=dcbafe aria-selected=true>参数说明</a>
|
||
<a class=nav-link id=cedfabTab data-bs-toggle=tab data-bs-target=#cedfab type=button role=tab aria-controls=cedfab aria-selected=true>响应示例</a></div></nav><div class=tab-content id=nav-tab-content><div class="tab-pane fade show active" id=cafedb role=tabpanel aria-labelledby=nav-1><div class=prism-codeblock><pre id=7504588 class=language-bash>
|
||
<code>curl --location --request POST 'http://localhost:3000/api/core/dataset/create' \
|
||
--header 'Authorization: Bearer {{authorization}}' \
|
||
--header 'Content-Type: application/json' \
|
||
--data-raw '{
|
||
"parentId": null,
|
||
"type": "dataset",
|
||
"name":"测试",
|
||
"intro":"介绍",
|
||
"avatar": "",
|
||
"vectorModel": "text-embedding-ada-002",
|
||
"agentModel": "gpt-3.5-turbo-16k"
|
||
}'</code>
|
||
</pre></div></div><div class="tab-pane fade" id=dcbafe role=tabpanel aria-labelledby=nav-1><div class="alert alert-success d-flex" role=alert><div class="flex-shrink-1 alert-icon"></div><div class=w-100><ul><li>parentId - 父级ID，用于构建目录结构。通常可以为 null 或者直接不传。</li><li>type - <code>dataset</code>或者<code>folder</code>，代表普通知识库和文件夹。不传则代表创建普通知识库。</li><li>name - 知识库名（必填）</li><li>intro - 介绍（可选）</li><li>avatar - 头像地址（可选）</li><li>vectorModel - 向量模型（建议传空，用系统默认的）</li><li>agentModel - 文本处理模型（建议传空，用系统默认的）</li></ul></div></div></div><div class="tab-pane fade" id=cedfab role=tabpanel aria-labelledby=nav-1><div class=prism-codeblock><pre id=0cf9068 class=language-json>
|
||
<code>{
|
||
"code": 200,
|
||
"statusText": "",
|
||
"message": "",
|
||
"data": "65abc9bd9d1448617cba5e6c"
|
||
}</code>
|
||
</pre></div></div></div><h3 id=获取知识库列表>获取知识库列表 <a href=#%e8%8e%b7%e5%8f%96%e7%9f%a5%e8%af%86%e5%ba%93%e5%88%97%e8%a1%a8 class=anchor aria-hidden=true><i class="material-icons align-middle">link</i></a></h3><nav><div class="nav nav-tabs" id=nav-tab role=tablist><a class="nav-link active" id=aefdcbTab data-bs-toggle=tab data-bs-target=#aefdcb type=button role=tab aria-controls=aefdcb aria-selected=true>请求示例</a>
|
||
<a class=nav-link id=ecbafdTab data-bs-toggle=tab data-bs-target=#ecbafd type=button role=tab aria-controls=ecbafd aria-selected=true>参数说明</a>
|
||
<a class=nav-link id=afcedbTab data-bs-toggle=tab data-bs-target=#afcedb type=button role=tab aria-controls=afcedb aria-selected=true>响应示例</a></div></nav><div class=tab-content id=nav-tab-content><div class="tab-pane fade show active" id=aefdcb role=tabpanel aria-labelledby=nav-1><div class=prism-codeblock><pre id=ad43524 class=language-bash>
|
||
<code>curl --location --request POST 'http://localhost:3000/api/core/dataset/list?parentId=' \
|
||
--header 'Authorization: Bearer xxxx' \
|
||
--header 'Content-Type: application/json' \
|
||
--data-raw '{
|
||
"parentId":""
|
||
}'</code>
|
||
</pre></div></div><div class="tab-pane fade" id=ecbafd role=tabpanel aria-labelledby=nav-1><div class="alert alert-success d-flex" role=alert><div class="flex-shrink-1 alert-icon"></div><div class=w-100><ul><li>parentId - 父级ID，传空字符串或者null，代表获取根目录下的知识库</li></ul></div></div></div><div class="tab-pane fade" id=afcedb role=tabpanel aria-labelledby=nav-1><div class=prism-codeblock><pre id=b609626 class=language-json>
|
||
<code>{
|
||
"code": 200,
|
||
"statusText": "",
|
||
"message": "",
|
||
"data": [
|
||
{
|
||
"_id": "65abc9bd9d1448617cba5e6c",
|
||
"parentId": null,
|
||
"avatar": "",
|
||
"name": "测试",
|
||
"intro": "",
|
||
"type": "dataset",
|
||
"permission": "private",
|
||
"canWrite": true,
|
||
"isOwner": true,
|
||
"vectorModel": {
|
||
"model": "text-embedding-ada-002",
|
||
"name": "Embedding-2",
|
||
"charsPointsPrice": 0,
|
||
"defaultToken": 512,
|
||
"maxToken": 8000,
|
||
"weight": 100
|
||
}
|
||
}
|
||
]
|
||
}</code>
|
||
</pre></div></div></div><h3 id=获取知识库详情>获取知识库详情 <a href=#%e8%8e%b7%e5%8f%96%e7%9f%a5%e8%af%86%e5%ba%93%e8%af%a6%e6%83%85 class=anchor aria-hidden=true><i class="material-icons align-middle">link</i></a></h3><nav><div class="nav nav-tabs" id=nav-tab role=tablist><a class="nav-link active" id=fcdbeaTab data-bs-toggle=tab data-bs-target=#fcdbea type=button role=tab aria-controls=fcdbea aria-selected=true>请求示例</a>
|
||
<a class=nav-link id=bdacefTab data-bs-toggle=tab data-bs-target=#bdacef type=button role=tab aria-controls=bdacef aria-selected=true>参数说明</a>
|
||
<a class=nav-link id=cbedfaTab data-bs-toggle=tab data-bs-target=#cbedfa type=button role=tab aria-controls=cbedfa aria-selected=true>响应示例</a></div></nav><div class=tab-content id=nav-tab-content><div class="tab-pane fade show active" id=fcdbea role=tabpanel aria-labelledby=nav-1><div class=prism-codeblock><pre id=d8ac2f3 class=language-bash>
|
||
<code>curl --location --request GET 'http://localhost:3000/api/core/dataset/detail?id=6593e137231a2be9c5603ba7' \
|
||
--header 'Authorization: Bearer {{authorization}}' \</code>
|
||
</pre></div></div><div class="tab-pane fade" id=bdacef role=tabpanel aria-labelledby=nav-1><div class="alert alert-success d-flex" role=alert><div class="flex-shrink-1 alert-icon"></div><div class=w-100><ul><li>id: 知识库的ID</li></ul></div></div></div><div class="tab-pane fade" id=cbedfa role=tabpanel aria-labelledby=nav-1><div class=prism-codeblock><pre id=fd4e58e class=language-json>
|
||
<code>{
|
||
"code": 200,
|
||
"statusText": "",
|
||
"message": "",
|
||
"data": {
|
||
"_id": "6593e137231a2be9c5603ba7",
|
||
"parentId": null,
|
||
"teamId": "65422be6aa44b7da77729ec8",
|
||
"tmbId": "65422be6aa44b7da77729ec9",
|
||
"type": "dataset",
|
||
"status": "active",
|
||
"avatar": "/icon/logo.svg",
|
||
"name": "FastGPT test",
|
||
"vectorModel": {
|
||
"model": "text-embedding-ada-002",
|
||
"name": "Embedding-2",
|
||
"charsPointsPrice": 0,
|
||
"defaultToken": 512,
|
||
"maxToken": 8000,
|
||
"weight": 100
|
||
},
|
||
"agentModel": {
|
||
"model": "gpt-3.5-turbo-16k",
|
||
"name": "FastAI-16k",
|
||
"maxContext": 16000,
|
||
"maxResponse": 16000,
|
||
"charsPointsPrice": 0
|
||
},
|
||
"intro": "",
|
||
"permission": "private",
|
||
"updateTime": "2024-01-02T10:11:03.084Z",
|
||
"canWrite": true,
|
||
"isOwner": true
|
||
}
|
||
}</code>
|
||
</pre></div></div></div><h3 id=删除一个知识库>删除一个知识库 <a href=#%e5%88%a0%e9%99%a4%e4%b8%80%e4%b8%aa%e7%9f%a5%e8%af%86%e5%ba%93 class=anchor aria-hidden=true><i class="material-icons align-middle">link</i></a></h3><nav><div class="nav nav-tabs" id=nav-tab role=tablist><a class="nav-link active" id=efdcabTab data-bs-toggle=tab data-bs-target=#efdcab type=button role=tab aria-controls=efdcab aria-selected=true>请求示例</a>
|
||
<a class=nav-link id=dfbceaTab data-bs-toggle=tab data-bs-target=#dfbcea type=button role=tab aria-controls=dfbcea aria-selected=true>参数说明</a>
|
||
<a class=nav-link id=bdfceaTab data-bs-toggle=tab data-bs-target=#bdfcea type=button role=tab aria-controls=bdfcea aria-selected=true>响应示例</a></div></nav><div class=tab-content id=nav-tab-content><div class="tab-pane fade show active" id=efdcab role=tabpanel aria-labelledby=nav-1><div class=prism-codeblock><pre id=b230c4d class=language-bash>
|
||
<code>curl --location --request DELETE 'http://localhost:3000/api/core/dataset/delete?id=65abc8729d1448617cba5df6' \
|
||
--header 'Authorization: Bearer {{authorization}}' \</code>
|
||
</pre></div></div><div class="tab-pane fade" id=dfbcea role=tabpanel aria-labelledby=nav-1><div class="alert alert-success d-flex" role=alert><div class="flex-shrink-1 alert-icon"></div><div class=w-100><ul><li>id: 知识库的ID</li></ul></div></div></div><div class="tab-pane fade" id=bdfcea role=tabpanel aria-labelledby=nav-1><div class=prism-codeblock><pre id=110f134 class=language-json>
|
||
<code>{
|
||
"code": 200,
|
||
"statusText": "",
|
||
"message": "",
|
||
"data": null
|
||
}</code>
|
||
</pre></div></div></div><h2 id=集合>集合 <a href=#%e9%9b%86%e5%90%88 class=anchor aria-hidden=true><i class="material-icons align-middle">link</i></a></h2><h3 id=通用创建参数说明必看>通用创建参数说明（必看） <a href=#%e9%80%9a%e7%94%a8%e5%88%9b%e5%bb%ba%e5%8f%82%e6%95%b0%e8%af%b4%e6%98%8e%e5%bf%85%e7%9c%8b class=anchor aria-hidden=true><i class="material-icons align-middle">link</i></a></h3><p><strong>入参</strong></p><table><thead><tr><th>参数</th><th>说明</th><th>必填</th></tr></thead><tbody><tr><td>datasetId</td><td>知识库ID</td><td>✅</td></tr><tr><td>parentId：</td><td>父级ID，不填则默认为根目录</td><td></td></tr><tr><td>trainingType</td><td>数据处理方式。chunk: 按文本长度进行分割;qa: 问答对提取</td><td>✅</td></tr><tr><td>autoIndexes</td><td>是否自动生成索引(仅商业版支持)</td><td></td></tr><tr><td>imageIndex</td><td>是否自动生成图片索引(仅商业版支持)</td><td></td></tr><tr><td>chunkSettingMode</td><td>分块参数模式。auto: 系统默认参数; custom: 手动指定参数</td><td></td></tr><tr><td>chunkSplitMode</td><td>分块拆分模式。size: 按长度拆分; char: 按字符拆分。chunkSettingMode=auto时不生效。</td><td></td></tr><tr><td>chunkSize</td><td>分块大小，默认 1500。chunkSettingMode=auto时不生效。</td><td></td></tr><tr><td>indexSize</td><td>索引大小，默认 512，必须小于索引模型最大token。chunkSettingMode=auto时不生效。</td><td></td></tr><tr><td>chunkSplitter</td><td>自定义最高优先分割符号，除非超出文件处理最大上下文，否则不会进行进一步拆分。chunkSettingMode=auto时不生效。</td><td></td></tr><tr><td>qaPrompt</td><td>qa拆分提示词</td><td></td></tr><tr><td>tags</td><td>集合标签（字符串数组）</td><td></td></tr><tr><td>createTime</td><td>文件创建时间（Date / String）</td><td></td></tr></tbody></table><p><strong>出参</strong></p><ul><li>collectionId - 新建的集合ID</li><li>insertLen：插入的块数量</li></ul><h3 id=创建一个空的集合>创建一个空的集合 <a href=#%e5%88%9b%e5%bb%ba%e4%b8%80%e4%b8%aa%e7%a9%ba%e7%9a%84%e9%9b%86%e5%90%88 class=anchor aria-hidden=true><i class="material-icons align-middle">link</i></a></h3><nav><div class="nav nav-tabs" id=nav-tab role=tablist><a class="nav-link active" id=adcbfeTab data-bs-toggle=tab data-bs-target=#adcbfe type=button role=tab aria-controls=adcbfe aria-selected=true>请求示例</a>
|
||
<a class=nav-link id=bfedcaTab data-bs-toggle=tab data-bs-target=#bfedca type=button role=tab aria-controls=bfedca aria-selected=true>参数说明</a>
|
||
<a class=nav-link id=abefdcTab data-bs-toggle=tab data-bs-target=#abefdc type=button role=tab aria-controls=abefdc aria-selected=true>响应示例</a></div></nav><div class=tab-content id=nav-tab-content><div class="tab-pane fade show active" id=adcbfe role=tabpanel aria-labelledby=nav-1><div class=prism-codeblock><pre id=7975e1d class=language-bash>
|
||
<code>curl --location --request POST 'http://localhost:3000/api/core/dataset/collection/create' \
|
||
--header 'Authorization: Bearer {{authorization}}' \
|
||
--header 'Content-Type: application/json' \
|
||
--data-raw '{
|
||
"datasetId":"6593e137231a2be9c5603ba7",
|
||
"parentId": null,
|
||
"name":"测试",
|
||
"type":"virtual",
|
||
"metadata":{
|
||
"test":111
|
||
}
|
||
}'</code>
|
||
</pre></div></div><div class="tab-pane fade" id=bfedca role=tabpanel aria-labelledby=nav-1><div class="alert alert-success d-flex" role=alert><div class="flex-shrink-1 alert-icon"></div><div class=w-100><ul><li>datasetId: 知识库的ID(必填)</li><li>parentId： 父级ID，不填则默认为根目录</li><li>name: 集合名称（必填）</li><li>type:<ul><li>folder：文件夹</li><li>virtual：虚拟集合(手动集合)</li></ul></li><li>metadata： 元数据（暂时没啥用）</li></ul></div></div></div><div class="tab-pane fade" id=abefdc role=tabpanel aria-labelledby=nav-1><p>data 为集合的 ID。</p><div class=prism-codeblock><pre id=b477741 class=language-json>
|
||
<code>{
|
||
"code": 200,
|
||
"statusText": "",
|
||
"message": "",
|
||
"data": "65abcd009d1448617cba5ee1"
|
||
}</code>
|
||
</pre></div></div></div><h3 id=创建一个纯文本集合>创建一个纯文本集合 <a href=#%e5%88%9b%e5%bb%ba%e4%b8%80%e4%b8%aa%e7%ba%af%e6%96%87%e6%9c%ac%e9%9b%86%e5%90%88 class=anchor aria-hidden=true><i class="material-icons align-middle">link</i></a></h3><p>传入一段文字，创建一个集合，会根据传入的文字进行分割。</p><nav><div class="nav nav-tabs" id=nav-tab role=tablist><a class="nav-link active" id=ecdfbaTab data-bs-toggle=tab data-bs-target=#ecdfba type=button role=tab aria-controls=ecdfba aria-selected=true>请求示例</a>
|
||
<a class=nav-link id=eabcfdTab data-bs-toggle=tab data-bs-target=#eabcfd type=button role=tab aria-controls=eabcfd aria-selected=true>参数说明</a>
|
||
<a class=nav-link id=febdacTab data-bs-toggle=tab data-bs-target=#febdac type=button role=tab aria-controls=febdac aria-selected=true>响应示例</a></div></nav><div class=tab-content id=nav-tab-content><div class="tab-pane fade show active" id=ecdfba role=tabpanel aria-labelledby=nav-1><div class=prism-codeblock><pre id=e722b1a class=language-bash>
|
||
<code>curl --location --request POST 'http://localhost:3000/api/core/dataset/collection/create/text' \
|
||
--header 'Authorization: Bearer {{authorization}}' \
|
||
--header 'Content-Type: application/json' \
|
||
--data-raw '{
|
||
"text":"xxxxxxxx",
|
||
"datasetId":"6593e137231a2be9c5603ba7",
|
||
"parentId": null,
|
||
"name":"测试训练",
|
||
|
||
"trainingType": "qa",
|
||
"chunkSettingMode": "auto",
|
||
"qaPrompt":"",
|
||
|
||
"metadata":{}
|
||
}'</code>
|
||
</pre></div></div><div class="tab-pane fade" id=eabcfd role=tabpanel aria-labelledby=nav-1><div class="alert alert-success d-flex" role=alert><div class="flex-shrink-1 alert-icon"></div><div class=w-100><ul><li>text: 原文本</li><li>datasetId: 知识库的ID(必填)</li><li>parentId： 父级ID，不填则默认为根目录</li><li>name: 集合名称（必填）</li><li>metadata： 元数据（暂时没啥用）</li></ul></div></div></div><div class="tab-pane fade" id=febdac role=tabpanel aria-labelledby=nav-1><p>data 为集合的 ID。</p><div class=prism-codeblock><pre id=894d0ff class=language-json>
|
||
<code>{
|
||
"code": 200,
|
||
"statusText": "",
|
||
"message": "",
|
||
"data": {
|
||
"collectionId": "65abcfab9d1448617cba5f0d",
|
||
"results": {
|
||
"insertLen": 5, // 分割成多少段
|
||
"overToken": [],
|
||
"repeat": [],
|
||
"error": []
|
||
}
|
||
}
|
||
}</code>
|
||
</pre></div></div></div><h3 id=创建一个链接集合>创建一个链接集合 <a href=#%e5%88%9b%e5%bb%ba%e4%b8%80%e4%b8%aa%e9%93%be%e6%8e%a5%e9%9b%86%e5%90%88 class=anchor aria-hidden=true><i class="material-icons align-middle">link</i></a></h3><p>传入一个网络链接，创建一个集合，会先去对应网页抓取内容，再抓取的文字进行分割。</p><nav><div class="nav nav-tabs" id=nav-tab role=tablist><a class="nav-link active" id=dfaecbTab data-bs-toggle=tab data-bs-target=#dfaecb type=button role=tab aria-controls=dfaecb aria-selected=true>请求示例</a>
|
||
<a class=nav-link id=bdeafcTab data-bs-toggle=tab data-bs-target=#bdeafc type=button role=tab aria-controls=bdeafc aria-selected=true>参数说明</a>
|
||
<a class=nav-link id=fbadceTab data-bs-toggle=tab data-bs-target=#fbadce type=button role=tab aria-controls=fbadce aria-selected=true>响应示例</a></div></nav><div class=tab-content id=nav-tab-content><div class="tab-pane fade show active" id=dfaecb role=tabpanel aria-labelledby=nav-1><div class=prism-codeblock><pre id=dfe3d23 class=language-bash>
|
||
<code>curl --location --request POST 'http://localhost:3000/api/core/dataset/collection/create/link' \
|
||
--header 'Authorization: Bearer {{authorization}}' \
|
||
--header 'Content-Type: application/json' \
|
||
--data-raw '{
|
||
"link":"https://doc.tryfastgpt.ai/docs/course/quick-start/",
|
||
"datasetId":"6593e137231a2be9c5603ba7",
|
||
"parentId": null,
|
||
|
||
"trainingType": "chunk",
|
||
"chunkSettingMode": "auto",
|
||
"qaPrompt":"",
|
||
|
||
"metadata":{
|
||
"webPageSelector":".docs-content"
|
||
}
|
||
}'</code>
|
||
</pre></div></div><div class="tab-pane fade" id=bdeafc role=tabpanel aria-labelledby=nav-1><div class="alert alert-success d-flex" role=alert><div class="flex-shrink-1 alert-icon"></div><div class=w-100><ul><li>link: 网络链接</li><li>datasetId: 知识库的ID(必填)</li><li>parentId： 父级ID，不填则默认为根目录</li><li>metadata.webPageSelector: 网页选择器，用于指定网页中的哪个元素作为文本(可选)</li></ul></div></div></div><div class="tab-pane fade" id=fbadce role=tabpanel aria-labelledby=nav-1><p>data 为集合的 ID。</p><div class=prism-codeblock><pre id=dacf32a class=language-json>
|
||
<code>{
|
||
"code": 200,
|
||
"statusText": "",
|
||
"message": "",
|
||
"data": {
|
||
"collectionId": "65abd0ad9d1448617cba6031",
|
||
"results": {
|
||
"insertLen": 1,
|
||
"overToken": [],
|
||
"repeat": [],
|
||
"error": []
|
||
}
|
||
}
|
||
}</code>
|
||
</pre></div></div></div><h3 id=创建一个文件集合>创建一个文件集合 <a href=#%e5%88%9b%e5%bb%ba%e4%b8%80%e4%b8%aa%e6%96%87%e4%bb%b6%e9%9b%86%e5%90%88 class=anchor aria-hidden=true><i class="material-icons align-middle">link</i></a></h3><p>传入一个文件，创建一个集合，会读取文件内容进行分割。目前支持：pdf, docx, md, txt, html, csv。</p><nav><div class="nav nav-tabs" id=nav-tab role=tablist><a class="nav-link active" id=cdabefTab data-bs-toggle=tab data-bs-target=#cdabef type=button role=tab aria-controls=cdabef aria-selected=true>请求示例</a>
|
||
<a class=nav-link id=dbfaceTab data-bs-toggle=tab data-bs-target=#dbface type=button role=tab aria-controls=dbface aria-selected=true>参数说明</a>
|
||
<a class=nav-link id=acbdfeTab data-bs-toggle=tab data-bs-target=#acbdfe type=button role=tab aria-controls=acbdfe aria-selected=true>响应示例</a></div></nav><div class=tab-content id=nav-tab-content><div class="tab-pane fade show active" id=cdabef role=tabpanel aria-labelledby=nav-1><p>使用代码上传时，请注意中文 filename 需要进行 encode 处理，否则容易乱码。</p><div class=prism-codeblock><pre id=21f1c50 class=language-bash>
|
||
<code>curl --location --request POST 'http://localhost:3000/api/core/dataset/collection/create/localFile' \
|
||
--header 'Authorization: Bearer {{authorization}}' \
|
||
--form 'file=@"C:\\Users\\user\\Desktop\\fastgpt测试文件\\index.html"' \
|
||
--form 'data="{\"datasetId\":\"6593e137231a2be9c5603ba7\",\"parentId\":null,\"trainingType\":\"chunk\",\"chunkSize\":512,\"chunkSplitter\":\"\",\"qaPrompt\":\"\",\"metadata\":{}}"'</code>
|
||
</pre></div></div><div class="tab-pane fade" id=dbface role=tabpanel aria-labelledby=nav-1><p>需要使用 POST form-data 的格式上传。包含 file 和 data 两个字段。</p><div class="alert alert-success d-flex" role=alert><div class="flex-shrink-1 alert-icon"></div><div class=w-100><ul><li>file: 文件</li><li>data: 知识库相关信息（json序列化后传入）,参数说明见上方“通用创建参数说明”</li></ul></div></div></div><div class="tab-pane fade" id=acbdfe role=tabpanel aria-labelledby=nav-1><p>data 为集合的 ID。</p><div class=prism-codeblock><pre id=e329820 class=language-json>
|
||
<code>{
|
||
"code": 200,
|
||
"statusText": "",
|
||
"message": "",
|
||
"data": {
|
||
"collectionId": "65abc044e4704bac793fbd81",
|
||
"results": {
|
||
"insertLen": 1,
|
||
"overToken": [],
|
||
"repeat": [],
|
||
"error": []
|
||
}
|
||
}
|
||
}</code>
|
||
</pre></div></div></div><h3 id=创建一个api集合>创建一个API集合 <a href=#%e5%88%9b%e5%bb%ba%e4%b8%80%e4%b8%aaapi%e9%9b%86%e5%90%88 class=anchor aria-hidden=true><i class="material-icons align-middle">link</i></a></h3><p>传入一个文件的 id，创建一个集合，会读取文件内容进行分割。目前支持：pdf, docx, md, txt, html, csv。</p><nav><div class="nav nav-tabs" id=nav-tab role=tablist><a class="nav-link active" id=adcfebTab data-bs-toggle=tab data-bs-target=#adcfeb type=button role=tab aria-controls=adcfeb aria-selected=true>请求示例</a>
|
||
<a class=nav-link id=fdbaecTab data-bs-toggle=tab data-bs-target=#fdbaec type=button role=tab aria-controls=fdbaec aria-selected=true>参数说明</a>
|
||
<a class=nav-link id=ecafdbTab data-bs-toggle=tab data-bs-target=#ecafdb type=button role=tab aria-controls=ecafdb aria-selected=true>响应示例</a></div></nav><div class=tab-content id=nav-tab-content><div class="tab-pane fade show active" id=adcfeb role=tabpanel aria-labelledby=nav-1><p>使用代码上传时，请注意中文 filename 需要进行 encode 处理，否则容易乱码。</p><div class=prism-codeblock><pre id=04ae4e9 class=language-bash>
|
||
<code>curl --location --request POST 'http://localhost:3000/api/core/dataset/collection/create/apiCollection' \
|
||
--header 'Authorization: Bearer fastgpt-xxx' \
|
||
--header 'Content-Type: application/json' \
|
||
--data-raw '{
|
||
"name": "A Quick Guide to Building a Discord Bot.pdf",
|
||
"apiFileId":"A Quick Guide to Building a Discord Bot.pdf",
|
||
|
||
"datasetId": "674e9e479c3503c385495027",
|
||
"parentId": null,
|
||
|
||
"trainingType": "chunk",
|
||
"chunkSize":512,
|
||
"chunkSplitter":"",
|
||
"qaPrompt":""
|
||
}'</code>
|
||
</pre></div></div><div class="tab-pane fade" id=fdbaec role=tabpanel aria-labelledby=nav-1><p>需要使用 POST form-data 的格式上传。包含 file 和 data 两个字段。</p><div class="alert alert-success d-flex" role=alert><div class="flex-shrink-1 alert-icon"></div><div class=w-100><ul><li>name: 集合名，建议就用文件名，必填。</li><li>apiFileId: 文件的ID，必填。</li><li>datasetId: 知识库的ID(必填)</li><li>parentId： 父级ID，不填则默认为根目录</li><li>trainingType:训练模式（必填）</li><li>chunkSize: 每个 chunk 的长度（可选）. chunk模式:100~3000; qa模式: 4000~模型最大token（16k模型通常建议不超过10000）</li><li>chunkSplitter: 自定义最高优先分割符号（可选）</li><li>qaPrompt: qa拆分自定义提示词（可选）</li></ul></div></div></div><div class="tab-pane fade" id=ecafdb role=tabpanel aria-labelledby=nav-1><p>data 为集合的 ID。</p><div class=prism-codeblock><pre id=e329820 class=language-json>
|
||
<code>{
|
||
"code": 200,
|
||
"statusText": "",
|
||
"message": "",
|
||
"data": {
|
||
"collectionId": "65abc044e4704bac793fbd81",
|
||
"results": {
|
||
"insertLen": 1,
|
||
"overToken": [],
|
||
"repeat": [],
|
||
"error": []
|
||
}
|
||
}
|
||
}</code>
|
||
</pre></div></div></div><h3 id=创建一个外部文件库集合商业版>创建一个外部文件库集合（商业版） <a href=#%e5%88%9b%e5%bb%ba%e4%b8%80%e4%b8%aa%e5%a4%96%e9%83%a8%e6%96%87%e4%bb%b6%e5%ba%93%e9%9b%86%e5%90%88%e5%95%86%e4%b8%9a%e7%89%88 class=anchor aria-hidden=true><i class="material-icons align-middle">link</i></a></h3><nav><div class="nav nav-tabs" id=nav-tab role=tablist><a class="nav-link active" id=efdcabTab data-bs-toggle=tab data-bs-target=#efdcab type=button role=tab aria-controls=efdcab aria-selected=true>请求示例</a>
|
||
<a class=nav-link id=debcfaTab data-bs-toggle=tab data-bs-target=#debcfa type=button role=tab aria-controls=debcfa aria-selected=true>参数说明</a>
|
||
<a class=nav-link id=bdaefcTab data-bs-toggle=tab data-bs-target=#bdaefc type=button role=tab aria-controls=bdaefc aria-selected=true>响应示例</a></div></nav><div class=tab-content id=nav-tab-content><div class="tab-pane fade show active" id=efdcab role=tabpanel aria-labelledby=nav-1><div class=prism-codeblock><pre id=6a376aa class=language-bash>
|
||
<code>curl --location --request POST 'http://localhost:3000/api/proApi/core/dataset/collection/create/externalFileUrl' \
|
||
--header 'Authorization: Bearer {{authorization}}' \
|
||
--header 'User-Agent: Apifox/1.0.0 (https://apifox.com)' \
|
||
--header 'Content-Type: application/json' \
|
||
--data-raw '{
|
||
"externalFileUrl":"https://image.xxxxx.com/fastgpt-dev/%E6%91%82.pdf",
|
||
"externalFileId":"1111",
|
||
"createTime": "2024-05-01T00:00:00.000Z",
|
||
"filename":"自定义文件名.pdf",
|
||
"datasetId":"6642d105a5e9d2b00255b27b",
|
||
"parentId": null,
|
||
"tags": ["tag1","tag2"],
|
||
|
||
"trainingType": "chunk",
|
||
"chunkSize":512,
|
||
"chunkSplitter":"",
|
||
"qaPrompt":""
|
||
}'</code>
|
||
</pre></div></div><div class="tab-pane fade" id=debcfa role=tabpanel aria-labelledby=nav-1><table><thead><tr><th>参数</th><th>说明</th><th>必填</th></tr></thead><tbody><tr><td>externalFileUrl</td><td>文件访问链接（可以是临时链接）</td><td>✅</td></tr><tr><td>externalFileId</td><td>外部文件ID</td><td></td></tr><tr><td>filename</td><td>自定义文件名，需要带后缀</td><td></td></tr><tr><td>createTime</td><td>文件创建时间（Date ISO 字符串都 ok）</td><td></td></tr></tbody></table></div><div class="tab-pane fade" id=bdaefc role=tabpanel aria-labelledby=nav-1><p>data 为集合的 ID。</p><div class=prism-codeblock><pre id=e975b16 class=language-json>
|
||
<code>{
|
||
"code": 200,
|
||
"statusText": "",
|
||
"message": "",
|
||
"data": {
|
||
"collectionId": "6646fcedfabd823cdc6de746",
|
||
"results": {
|
||
"insertLen": 1,
|
||
"overToken": [],
|
||
"repeat": [],
|
||
"error": []
|
||
}
|
||
}
|
||
}</code>
|
||
</pre></div></div></div><h3 id=获取集合列表>获取集合列表 <a href=#%e8%8e%b7%e5%8f%96%e9%9b%86%e5%90%88%e5%88%97%e8%a1%a8 class=anchor aria-hidden=true><i class="material-icons align-middle">link</i></a></h3><nav><div class="nav nav-tabs" id=nav-tab role=tablist><a class="nav-link active" id=bdaefcTab data-bs-toggle=tab data-bs-target=#bdaefc type=button role=tab aria-controls=bdaefc aria-selected=true>请求示例</a>
|
||
<a class=nav-link id=cabfdeTab data-bs-toggle=tab data-bs-target=#cabfde type=button role=tab aria-controls=cabfde aria-selected=true>参数说明</a>
|
||
<a class=nav-link id=cfdaebTab data-bs-toggle=tab data-bs-target=#cfdaeb type=button role=tab aria-controls=cfdaeb aria-selected=true>响应示例</a></div></nav><div class=tab-content id=nav-tab-content><div class="tab-pane fade show active" id=bdaefc role=tabpanel aria-labelledby=nav-1><p><strong>4.8.19+</strong></p><div class=prism-codeblock><pre id=e6045ac class=language-bash>
|
||
<code>curl --location --request POST 'http://localhost:3000/api/core/dataset/collection/listV2' \
|
||
--header 'Authorization: Bearer {{authorization}}' \
|
||
--header 'Content-Type: application/json' \
|
||
--data-raw '{
|
||
"offset":0,
|
||
"pageSize": 10,
|
||
"datasetId":"6593e137231a2be9c5603ba7",
|
||
"parentId": null,
|
||
"searchText":""
|
||
}'</code>
|
||
</pre></div><p><strong>4.8.19-(不再维护)</strong></p><div class=prism-codeblock><pre id=db43f6f class=language-bash>
|
||
<code>curl --location --request POST 'http://localhost:3000/api/core/dataset/collection/list' \
|
||
--header 'Authorization: Bearer {{authorization}}' \
|
||
--header 'Content-Type: application/json' \
|
||
--data-raw '{
|
||
"pageNum":1,
|
||
"pageSize": 10,
|
||
"datasetId":"6593e137231a2be9c5603ba7",
|
||
"parentId": null,
|
||
"searchText":""
|
||
}'</code>
|
||
</pre></div></div><div class="tab-pane fade" id=cabfde role=tabpanel aria-labelledby=nav-1><div class="alert alert-success d-flex" role=alert><div class="flex-shrink-1 alert-icon"></div><div class=w-100><ul><li>offset: 偏移量</li><li>pageSize: 每页数量，最大30（选填）</li><li>datasetId: 知识库的ID(必填)</li><li>parentId: 父级Id（选填）</li><li>searchText: 模糊搜索文本（选填）</li></ul></div></div></div><div class="tab-pane fade" id=cfdaeb role=tabpanel aria-labelledby=nav-1><div class=prism-codeblock><pre id=b1c4f71 class=language-json>
|
||
<code>{
|
||
"code": 200,
|
||
"statusText": "",
|
||
"message": "",
|
||
"data": {
|
||
"list": [
|
||
{
|
||
"_id": "6593e137231a2be9c5603ba9",
|
||
"parentId": null,
|
||
"tmbId": "65422be6aa44b7da77729ec9",
|
||
"type": "virtual",
|
||
"name": "手动录入",
|
||
"updateTime": "2099-01-01T00:00:00.000Z",
|
||
"dataAmount": 3,
|
||
"trainingAmount": 0,
|
||
"externalFileId": "1111",
|
||
"tags": [
|
||
"11",
|
||
"测试的"
|
||
],
|
||
"forbid": false,
|
||
"trainingType": "chunk",
|
||
"permission": {
|
||
"value": 4294967295,
|
||
"isOwner": true,
|
||
"hasManagePer": true,
|
||
"hasWritePer": true,
|
||
"hasReadPer": true
|
||
}
|
||
|
||
},
|
||
{
|
||
"_id": "65abd0ad9d1448617cba6031",
|
||
"parentId": null,
|
||
"tmbId": "65422be6aa44b7da77729ec9",
|
||
"type": "link",
|
||
"name": "快速上手 | FastGPT",
|
||
"rawLink": "https://doc.tryfastgpt.ai/docs/course/quick-start/",
|
||
"updateTime": "2024-01-20T13:54:53.031Z",
|
||
"dataAmount": 3,
|
||
"trainingAmount": 0,
|
||
"externalFileId": "222",
|
||
"tags": [
|
||
"测试的"
|
||
],
|
||
"forbid": false,
|
||
"trainingType": "chunk",
|
||
"permission": {
|
||
"value": 4294967295,
|
||
"isOwner": true,
|
||
"hasManagePer": true,
|
||
"hasWritePer": true,
|
||
"hasReadPer": true
|
||
}
|
||
}
|
||
],
|
||
"total": 93
|
||
}
|
||
}</code>
|
||
</pre></div></div></div><h3 id=获取集合详情>获取集合详情 <a href=#%e8%8e%b7%e5%8f%96%e9%9b%86%e5%90%88%e8%af%a6%e6%83%85 class=anchor aria-hidden=true><i class="material-icons align-middle">link</i></a></h3><nav><div class="nav nav-tabs" id=nav-tab role=tablist><a class="nav-link active" id=cbaedfTab data-bs-toggle=tab data-bs-target=#cbaedf type=button role=tab aria-controls=cbaedf aria-selected=true>请求示例</a>
|
||
<a class=nav-link id=fecdabTab data-bs-toggle=tab data-bs-target=#fecdab type=button role=tab aria-controls=fecdab aria-selected=true>参数说明</a>
|
||
<a class=nav-link id=fcbdeaTab data-bs-toggle=tab data-bs-target=#fcbdea type=button role=tab aria-controls=fcbdea aria-selected=true>响应示例</a></div></nav><div class=tab-content id=nav-tab-content><div class="tab-pane fade show active" id=cbaedf role=tabpanel aria-labelledby=nav-1><div class=prism-codeblock><pre id=0e43d03 class=language-bash>
|
||
<code>curl --location --request GET 'http://localhost:3000/api/core/dataset/collection/detail?id=65abcfab9d1448617cba5f0d' \
|
||
--header 'Authorization: Bearer {{authorization}}' \</code>
|
||
</pre></div></div><div class="tab-pane fade" id=fecdab role=tabpanel aria-labelledby=nav-1><div class="alert alert-success d-flex" role=alert><div class="flex-shrink-1 alert-icon"></div><div class=w-100><ul><li>id: 集合的ID</li></ul></div></div></div><div class="tab-pane fade" id=fcbdea role=tabpanel aria-labelledby=nav-1><div class=prism-codeblock><pre id=38aac6b class=language-json>
|
||
<code>{
|
||
"code": 200,
|
||
"statusText": "",
|
||
"message": "",
|
||
"data": {
|
||
"_id": "65abcfab9d1448617cba5f0d",
|
||
"parentId": null,
|
||
"teamId": "65422be6aa44b7da77729ec8",
|
||
"tmbId": "65422be6aa44b7da77729ec9",
|
||
"datasetId": {
|
||
"_id": "6593e137231a2be9c5603ba7",
|
||
"parentId": null,
|
||
"teamId": "65422be6aa44b7da77729ec8",
|
||
"tmbId": "65422be6aa44b7da77729ec9",
|
||
"type": "dataset",
|
||
"status": "active",
|
||
"avatar": "/icon/logo.svg",
|
||
"name": "FastGPT test",
|
||
"vectorModel": "text-embedding-ada-002",
|
||
"agentModel": "gpt-3.5-turbo-16k",
|
||
"intro": "",
|
||
"permission": "private",
|
||
"updateTime": "2024-01-02T10:11:03.084Z"
|
||
},
|
||
"type": "virtual",
|
||
"name": "测试训练",
|
||
"trainingType": "qa",
|
||
"chunkSize": 8000,
|
||
"chunkSplitter": "",
|
||
"qaPrompt": "11",
|
||
"rawTextLength": 40466,
|
||
"hashRawText": "47270840614c0cc122b29daaddc09c2a48f0ec6e77093611ab12b69cba7fee12",
|
||
"createTime": "2024-01-20T13:50:35.838Z",
|
||
"updateTime": "2024-01-20T13:50:35.838Z",
|
||
"canWrite": true,
|
||
"sourceName": "测试训练"
|
||
}
|
||
}</code>
|
||
</pre></div></div></div><h3 id=修改集合信息>修改集合信息 <a href=#%e4%bf%ae%e6%94%b9%e9%9b%86%e5%90%88%e4%bf%a1%e6%81%af class=anchor aria-hidden=true><i class="material-icons align-middle">link</i></a></h3><nav><div class="nav nav-tabs" id=nav-tab role=tablist><a class="nav-link active" id=ecfdbaTab data-bs-toggle=tab data-bs-target=#ecfdba type=button role=tab aria-controls=ecfdba aria-selected=true>请求示例</a>
|
||
<a class=nav-link id=fbeadcTab data-bs-toggle=tab data-bs-target=#fbeadc type=button role=tab aria-controls=fbeadc aria-selected=true>参数说明</a>
|
||
<a class=nav-link id=adbecfTab data-bs-toggle=tab data-bs-target=#adbecf type=button role=tab aria-controls=adbecf aria-selected=true>响应示例</a></div></nav><div class=tab-content id=nav-tab-content><div class="tab-pane fade show active" id=ecfdba role=tabpanel aria-labelledby=nav-1><p><strong>通过集合 ID 修改集合信息</strong></p><div class=prism-codeblock><pre id=5e24b49 class=language-bash>
|
||
<code>curl --location --request PUT 'http://localhost:3000/api/core/dataset/collection/update' \
|
||
--header 'Authorization: Bearer {{authorization}}' \
|
||
--header 'Content-Type: application/json' \
|
||
--data-raw '{
|
||
"id":"65abcfab9d1448617cba5f0d",
|
||
"parentId": null,
|
||
"name": "测2222试",
|
||
"tags": ["tag1", "tag2"],
|
||
"forbid": false,
|
||
"createTime": "2024-01-01T00:00:00.000Z"
|
||
}'</code>
|
||
</pre></div><p><strong>通过外部文件 ID 修改集合信息</strong>， 只需要把 id 换成 datasetId 和 externalFileId。</p><div class=prism-codeblock><pre id=4e4c268 class=language-bash>
|
||
<code>curl --location --request PUT 'http://localhost:3000/api/core/dataset/collection/update' \
|
||
--header 'Authorization: Bearer {{authorization}}' \
|
||
--header 'Content-Type: application/json' \
|
||
--data-raw '{
|
||
"datasetId":"6593e137231a2be9c5603ba7",
|
||
"externalFileId":"1111",
|
||
"parentId": null,
|
||
"name": "测2222试",
|
||
"tags": ["tag1", "tag2"],
|
||
"forbid": false,
|
||
"createTime": "2024-01-01T00:00:00.000Z"
|
||
}'</code>
|
||
</pre></div></div><div class="tab-pane fade" id=fbeadc role=tabpanel aria-labelledby=nav-1><div class="alert alert-success d-flex" role=alert><div class="flex-shrink-1 alert-icon"></div><div class=w-100><ul><li>id: 集合的ID</li><li>parentId: 修改父级ID（可选）</li><li>name: 修改集合名称（可选）</li><li>tags: 修改集合标签（可选）</li><li>forbid: 修改集合禁用状态（可选）</li><li>createTime: 修改集合创建时间（可选）</li></ul></div></div></div><div class="tab-pane fade" id=adbecf role=tabpanel aria-labelledby=nav-1><div class=prism-codeblock><pre id=110f134 class=language-json>
|
||
<code>{
|
||
"code": 200,
|
||
"statusText": "",
|
||
"message": "",
|
||
"data": null
|
||
}</code>
|
||
</pre></div></div></div><h3 id=删除一个集合>删除一个集合 <a href=#%e5%88%a0%e9%99%a4%e4%b8%80%e4%b8%aa%e9%9b%86%e5%90%88 class=anchor aria-hidden=true><i class="material-icons align-middle">link</i></a></h3><nav><div class="nav nav-tabs" id=nav-tab role=tablist><a class="nav-link active" id=abdfecTab data-bs-toggle=tab data-bs-target=#abdfec type=button role=tab aria-controls=abdfec aria-selected=true>请求示例</a>
|
||
<a class=nav-link id=cdbeafTab data-bs-toggle=tab data-bs-target=#cdbeaf type=button role=tab aria-controls=cdbeaf aria-selected=true>参数说明</a>
|
||
<a class=nav-link id=afdbceTab data-bs-toggle=tab data-bs-target=#afdbce type=button role=tab aria-controls=afdbce aria-selected=true>响应示例</a></div></nav><div class=tab-content id=nav-tab-content><div class="tab-pane fade show active" id=abdfec role=tabpanel aria-labelledby=nav-1><div class=prism-codeblock><pre id=ffbb5ae class=language-bash>
|
||
<code>curl --location --request DELETE 'http://localhost:3000/api/core/dataset/collection/delete?id=65aa2a64e6cb9b8ccdc00de8' \
|
||
--header 'Authorization: Bearer {{authorization}}' \</code>
|
||
</pre></div></div><div class="tab-pane fade" id=cdbeaf role=tabpanel aria-labelledby=nav-1><div class="alert alert-success d-flex" role=alert><div class="flex-shrink-1 alert-icon"></div><div class=w-100><ul><li>id: 集合的ID</li></ul></div></div></div><div class="tab-pane fade" id=afdbce role=tabpanel aria-labelledby=nav-1><div class=prism-codeblock><pre id=110f134 class=language-json>
|
||
<code>{
|
||
"code": 200,
|
||
"statusText": "",
|
||
"message": "",
|
||
"data": null
|
||
}</code>
|
||
</pre></div></div></div><h2 id=数据>数据 <a href=#%e6%95%b0%e6%8d%ae class=anchor aria-hidden=true><i class="material-icons align-middle">link</i></a></h2><h3 id=数据的结构>数据的结构 <a href=#%e6%95%b0%e6%8d%ae%e7%9a%84%e7%bb%93%e6%9e%84 class=anchor aria-hidden=true><i class="material-icons align-middle">link</i></a></h3><p><strong>Data结构</strong></p><table><thead><tr><th>字段</th><th>类型</th><th>说明</th><th>必填</th></tr></thead><tbody><tr><td>teamId</td><td>String</td><td>团队ID</td><td>✅</td></tr><tr><td>tmbId</td><td>String</td><td>成员ID</td><td>✅</td></tr><tr><td>datasetId</td><td>String</td><td>知识库ID</td><td>✅</td></tr><tr><td>collectionId</td><td>String</td><td>集合ID</td><td>✅</td></tr><tr><td>q</td><td>String</td><td>主要数据</td><td>✅</td></tr><tr><td>a</td><td>String</td><td>辅助数据</td><td>✖</td></tr><tr><td>fullTextToken</td><td>String</td><td>分词</td><td>✖</td></tr><tr><td>indexes</td><td>Index[]</td><td>向量索引</td><td>✅</td></tr><tr><td>updateTime</td><td>Date</td><td>更新时间</td><td>✅</td></tr><tr><td>chunkIndex</td><td>Number</td><td>分块下表</td><td>✖</td></tr></tbody></table><p><strong>Index结构</strong></p><p>每组数据的自定义索引最多5个</p><table><thead><tr><th>字段</th><th>类型</th><th>说明</th><th>必填</th></tr></thead><tbody><tr><td>type</td><td>String</td><td>可选索引类型：default-默认索引; custom-自定义索引; summary-总结索引; question-问题索引; image-图片索引</td><td></td></tr><tr><td>dataId</td><td>String</td><td>关联的向量ID，变更数据时候传入该 ID，会进行差量更新，而不是全量更新</td><td></td></tr><tr><td>text</td><td>String</td><td>文本内容</td><td>✅</td></tr></tbody></table><p><code>type</code> 不填则默认为 <code>custom</code> 索引，还会基于 q/a 组成一个默认索引。如果传入了默认索引，则不会额外创建。</p><h3 id=为集合批量添加添加数据>为集合批量添加添加数据 <a href=#%e4%b8%ba%e9%9b%86%e5%90%88%e6%89%b9%e9%87%8f%e6%b7%bb%e5%8a%a0%e6%b7%bb%e5%8a%a0%e6%95%b0%e6%8d%ae class=anchor aria-hidden=true><i class="material-icons align-middle">link</i></a></h3><p>注意，每次最多推送 200 组数据。</p><nav><div class="nav nav-tabs" id=nav-tab role=tablist><a class="nav-link active" id=becfdaTab data-bs-toggle=tab data-bs-target=#becfda type=button role=tab aria-controls=becfda aria-selected=true>请求示例</a>
|
||
<a class=nav-link id=efcdbaTab data-bs-toggle=tab data-bs-target=#efcdba type=button role=tab aria-controls=efcdba aria-selected=true>参数说明</a>
|
||
<a class=nav-link id=ebacdfTab data-bs-toggle=tab data-bs-target=#ebacdf type=button role=tab aria-controls=ebacdf aria-selected=true>响应例子</a>
|
||
<a class=nav-link id=edcafbTab data-bs-toggle=tab data-bs-target=#edcafb type=button role=tab aria-controls=edcafb aria-selected=true>QA Prompt 模板</a></div></nav><div class=tab-content id=nav-tab-content><div class="tab-pane fade show active" id=becfda role=tabpanel aria-labelledby=nav-1><div class=prism-codeblock><pre id=fb4644d class=language-bash>
|
||
<code>curl --location --request POST 'https://api.fastgpt.in/api/core/dataset/data/pushData' \
|
||
--header 'Authorization: Bearer apikey' \
|
||
--header 'Content-Type: application/json' \
|
||
--data-raw '{
|
||
"collectionId": "64663f451ba1676dbdef0499",
|
||
"trainingType": "chunk",
|
||
"prompt": "可选。qa 拆分引导词，chunk 模式下忽略",
|
||
"billId": "可选。如果有这个值，本次的数据会被聚合到一个订单中，这个值可以重复使用。可以参考 [创建训练订单] 获取该值。",
|
||
"data": [
|
||
{
|
||
"q": "你是谁？",
|
||
"a": "我是FastGPT助手"
|
||
},
|
||
{
|
||
"q": "你会什么？",
|
||
"a": "我什么都会",
|
||
"indexes": [
|
||
{
|
||
"text":"自定义索引1"
|
||
},
|
||
{
|
||
"text":"自定义索引2"
|
||
}
|
||
]
|
||
}
|
||
]
|
||
}'</code>
|
||
</pre></div></div><div class="tab-pane fade" id=efcdba role=tabpanel aria-labelledby=nav-1><div class="alert alert-success d-flex" role=alert><div class="flex-shrink-1 alert-icon"></div><div class=w-100><ul><li>collectionId: 集合ID（必填）</li><li>trainingType:训练模式（必填）</li><li>prompt: 自定义 QA 拆分提示词，需严格按照模板，建议不要传入。（选填）</li><li>data：（具体数据）<ul><li>q: 主要数据（必填）</li><li>a: 辅助数据（选填）</li><li>indexes: 自定义索引（选填）。可以不传或者传空数组，默认都会使用q和a组成一个索引。</li></ul></li></ul></div></div></div><div class="tab-pane fade" id=ebacdf role=tabpanel aria-labelledby=nav-1><div class=prism-codeblock><pre id=7f03318 class=language-json>
|
||
<code>{
|
||
"code": 200,
|
||
"statusText": "",
|
||
"data": {
|
||
"insertLen": 1, // 最终插入成功的数量
|
||
"overToken": [], // 超出 token 的
|
||
"repeat": [], // 重复的数量
|
||
"error": [] // 其他错误
|
||
}
|
||
}</code>
|
||
</pre></div></div><div class="tab-pane fade" id=edcafb role=tabpanel aria-labelledby=nav-1><p>{{theme}} 里的内容可以换成数据的主题。默认为：它们可能包含多个主题内容</p><div class=prism-codeblock><pre id=157ff98 class=language->
|
||
<code>我会给你一段文本，{{theme}}，学习它们，并整理学习成果，要求为：
|
||
1. 提出最多 25 个问题。
|
||
2. 给出每个问题的答案。
|
||
3. 答案要详细完整，答案可以包含普通文字、链接、代码、表格、公示、媒体链接等 markdown 元素。
|
||
4. 按格式返回多个问题和答案:
|
||
|
||
Q1: 问题。
|
||
A1: 答案。
|
||
Q2:
|
||
A2:
|
||
……
|
||
|
||
我的文本："""{{text}}"""</code>
|
||
</pre></div></div></div><h3 id=获取集合的数据列表>获取集合的数据列表 <a href=#%e8%8e%b7%e5%8f%96%e9%9b%86%e5%90%88%e7%9a%84%e6%95%b0%e6%8d%ae%e5%88%97%e8%a1%a8 class=anchor aria-hidden=true><i class="material-icons align-middle">link</i></a></h3><nav><div class="nav nav-tabs" id=nav-tab role=tablist><a class="nav-link active" id=febdcaTab data-bs-toggle=tab data-bs-target=#febdca type=button role=tab aria-controls=febdca aria-selected=true>请求示例</a>
|
||
<a class=nav-link id=ecdbfaTab data-bs-toggle=tab data-bs-target=#ecdbfa type=button role=tab aria-controls=ecdbfa aria-selected=true>参数说明</a>
|
||
<a class=nav-link id=bcfdeaTab data-bs-toggle=tab data-bs-target=#bcfdea type=button role=tab aria-controls=bcfdea aria-selected=true>响应示例</a></div></nav><div class=tab-content id=nav-tab-content><div class="tab-pane fade show active" id=febdca role=tabpanel aria-labelledby=nav-1><p><strong>4.8.11+</strong></p><div class=prism-codeblock><pre id=4f48963 class=language-bash>
|
||
<code>curl --location --request POST 'http://localhost:3000/api/core/dataset/data/v2/list' \
|
||
--header 'Authorization: Bearer {{authorization}}' \
|
||
--header 'Content-Type: application/json' \
|
||
--data-raw '{
|
||
"offset": 0,
|
||
"pageSize": 10,
|
||
"collectionId":"65abd4ac9d1448617cba6171",
|
||
"searchText":""
|
||
}'</code>
|
||
</pre></div><p><strong>4.6.7-(即将弃用)</strong></p><div class=prism-codeblock><pre id=5e9f2f3 class=language-bash>
|
||
<code>curl --location --request POST 'http://localhost:3000/api/core/dataset/data/list' \
|
||
--header 'Authorization: Bearer {{authorization}}' \
|
||
--header 'Content-Type: application/json' \
|
||
--data-raw '{
|
||
"pageNum":1,
|
||
"pageSize": 10,
|
||
"collectionId":"65abd4ac9d1448617cba6171",
|
||
"searchText":""
|
||
}'</code>
|
||
</pre></div></div><div class="tab-pane fade" id=ecdbfa role=tabpanel aria-labelledby=nav-1><div class="alert alert-success d-flex" role=alert><div class="flex-shrink-1 alert-icon"></div><div class=w-100><ul><li>offset: 偏移量（选填）</li><li>pageSize: 每页数量，最大30（选填）</li><li>collectionId: 集合的ID（必填）</li><li>searchText: 模糊搜索词（选填）</li></ul></div></div></div><div class="tab-pane fade" id=bcfdea role=tabpanel aria-labelledby=nav-1><div class=prism-codeblock><pre id=46460ff class=language-json>
|
||
<code>{
|
||
"code": 200,
|
||
"statusText": "",
|
||
"message": "",
|
||
"data": {
|
||
"list": [
|
||
{
|
||
"_id": "65abd4b29d1448617cba61db",
|
||
"datasetId": "65abc9bd9d1448617cba5e6c",
|
||
"collectionId": "65abd4ac9d1448617cba6171",
|
||
"q": "N o . 2 0 2 2 1 2中 国 信 息 通 信 研 究 院京东探索研究院2022年 9月人工智能生成内容（AIGC）白皮书(2022 年)版权声明本白皮书版权属于中国信息通信研究院和京东探索研究院，并受法律保护。转载、摘编或利用其它方式使用本白皮书文字或者观点的，应注明“来源：中国信息通信研究院和京东探索研究院”。违反上述声明者，编者将追究其相关法律责任。前 言习近平总书记曾指出，“数字技术正以新理念、新业态、新模式全面融入人类经济、政治、文化、社会、生态文明建设各领域和全过程”。在当前数字世界和物理世界加速融合的大背景下，人工智能生成内容（Artificial Intelligence Generated Content，简称 AIGC）正在悄然引导着一场深刻的变革，重塑甚至颠覆数字内容的生产方式和消费模式，将极大地丰富人们的数字生活，是未来全面迈向数字文明新时代不可或缺的支撑力量。",
|
||
"a": "",
|
||
"chunkIndex": 0
|
||
},
|
||
{
|
||
"_id": "65abd4b39d1448617cba624d",
|
||
"datasetId": "65abc9bd9d1448617cba5e6c",
|
||
"collectionId": "65abd4ac9d1448617cba6171",
|
||
"q": "本白皮书重点从 AIGC 技术、应用和治理等维度进行了阐述。在技术层面，梳理提出了 AIGC 技术体系，既涵盖了对现实世界各种内容的数字化呈现和增强，也包括了基于人工智能的自主内容创作。在应用层面，重点分析了 AIGC 在传媒、电商、影视等行业和场景的应用情况，探讨了以虚拟数字人、写作机器人等为代表的新业态和新应用。在治理层面，从政策监管、技术能力、企业应用等视角，分析了AIGC 所暴露出的版权纠纷、虚假信息传播等各种问题。最后，从政府、行业、企业、社会等层面，给出了 AIGC 发展和治理建议。由于人工智能仍处于飞速发展阶段，我们对 AIGC 的认识还有待进一步深化，白皮书中存在不足之处，敬请大家批评指正。目 录一、 人工智能生成内容的发展历程与概念.............................................................. 1（一）AIGC 历史沿革 .......................................................................................... 1（二）AIGC 的概念与内涵 .................................................................................. 4二、人工智能生成内容的技术体系及其演进方向.................................................... 7（一）AIGC 技术升级步入深化阶段 .................................................................. 7（二）AIGC 大模型架构潜力凸显 .................................................................... 10（三）AIGC 技术演化出三大前沿能力 ............................................................ 18三、人工智能生成内容的应用场景.......................................................................... 26（一）AIGC+传媒：人机协同生产，",
|
||
"a": "",
|
||
"chunkIndex": 1
|
||
}
|
||
],
|
||
"total": 63
|
||
}
|
||
}</code>
|
||
</pre></div></div></div><h3 id=获取单条数据详情>获取单条数据详情 <a href=#%e8%8e%b7%e5%8f%96%e5%8d%95%e6%9d%a1%e6%95%b0%e6%8d%ae%e8%af%a6%e6%83%85 class=anchor aria-hidden=true><i class="material-icons align-middle">link</i></a></h3><nav><div class="nav nav-tabs" id=nav-tab role=tablist><a class="nav-link active" id=cdfbeaTab data-bs-toggle=tab data-bs-target=#cdfbea type=button role=tab aria-controls=cdfbea aria-selected=true>请求示例</a>
|
||
<a class=nav-link id=cdbaefTab data-bs-toggle=tab data-bs-target=#cdbaef type=button role=tab aria-controls=cdbaef aria-selected=true>参数说明</a>
|
||
<a class=nav-link id=eacfbdTab data-bs-toggle=tab data-bs-target=#eacfbd type=button role=tab aria-controls=eacfbd aria-selected=true>响应示例</a></div></nav><div class=tab-content id=nav-tab-content><div class="tab-pane fade show active" id=cdfbea role=tabpanel aria-labelledby=nav-1><div class=prism-codeblock><pre id=a81d358 class=language-bash>
|
||
<code>curl --location --request GET 'http://localhost:3000/api/core/dataset/data/detail?id=65abd4b29d1448617cba61db' \
|
||
--header 'Authorization: Bearer {{authorization}}' \</code>
|
||
</pre></div></div><div class="tab-pane fade" id=cdbaef role=tabpanel aria-labelledby=nav-1><div class="alert alert-success d-flex" role=alert><div class="flex-shrink-1 alert-icon"></div><div class=w-100><ul><li>id: 数据的id</li></ul></div></div></div><div class="tab-pane fade" id=eacfbd role=tabpanel aria-labelledby=nav-1><div class=prism-codeblock><pre id=86701d5 class=language-json>
|
||
<code>{
|
||
"code": 200,
|
||
"statusText": "",
|
||
"message": "",
|
||
"data": {
|
||
"id": "65abd4b29d1448617cba61db",
|
||
"q": "N o . 2 0 2 2 1 2中 国 信 息 通 信 研 究 院京东探索研究院2022年 9月人工智能生成内容（AIGC）白皮书(2022 年)版权声明本白皮书版权属于中国信息通信研究院和京东探索研究院，并受法律保护。转载、摘编或利用其它方式使用本白皮书文字或者观点的，应注明“来源：中国信息通信研究院和京东探索研究院”。违反上述声明者，编者将追究其相关法律责任。前 言习近平总书记曾指出，“数字技术正以新理念、新业态、新模式全面融入人类经济、政治、文化、社会、生态文明建设各领域和全过程”。在当前数字世界和物理世界加速融合的大背景下，人工智能生成内容（Artificial Intelligence Generated Content，简称 AIGC）正在悄然引导着一场深刻的变革，重塑甚至颠覆数字内容的生产方式和消费模式，将极大地丰富人们的数字生活，是未来全面迈向数字文明新时代不可或缺的支撑力量。",
|
||
"a": "",
|
||
"chunkIndex": 0,
|
||
"indexes": [
|
||
{
|
||
"type": "default",
|
||
"dataId": "3720083",
|
||
"text": "N o . 2 0 2 2 1 2中 国 信 息 通 信 研 究 院京东探索研究院2022年 9月人工智能生成内容（AIGC）白皮书(2022 年)版权声明本白皮书版权属于中国信息通信研究院和京东探索研究院，并受法律保护。转载、摘编或利用其它方式使用本白皮书文字或者观点的，应注明“来源：中国信息通信研究院和京东探索研究院”。违反上述声明者，编者将追究其相关法律责任。前 言习近平总书记曾指出，“数字技术正以新理念、新业态、新模式全面融入人类经济、政治、文化、社会、生态文明建设各领域和全过程”。在当前数字世界和物理世界加速融合的大背景下，人工智能生成内容（Artificial Intelligence Generated Content，简称 AIGC）正在悄然引导着一场深刻的变革，重塑甚至颠覆数字内容的生产方式和消费模式，将极大地丰富人们的数字生活，是未来全面迈向数字文明新时代不可或缺的支撑力量。",
|
||
"_id": "65abd4b29d1448617cba61dc"
|
||
}
|
||
],
|
||
"datasetId": "65abc9bd9d1448617cba5e6c",
|
||
"collectionId": "65abd4ac9d1448617cba6171",
|
||
"sourceName": "中文-AIGC白皮书2022.pdf",
|
||
"sourceId": "65abd4ac9d1448617cba6166",
|
||
"isOwner": true,
|
||
"canWrite": true
|
||
}
|
||
}</code>
|
||
</pre></div></div></div><h3 id=修改单条数据>修改单条数据 <a href=#%e4%bf%ae%e6%94%b9%e5%8d%95%e6%9d%a1%e6%95%b0%e6%8d%ae class=anchor aria-hidden=true><i class="material-icons align-middle">link</i></a></h3><nav><div class="nav nav-tabs" id=nav-tab role=tablist><a class="nav-link active" id=edcafbTab data-bs-toggle=tab data-bs-target=#edcafb type=button role=tab aria-controls=edcafb aria-selected=true>请求示例</a>
|
||
<a class=nav-link id=cfdbaeTab data-bs-toggle=tab data-bs-target=#cfdbae type=button role=tab aria-controls=cfdbae aria-selected=true>参数说明</a>
|
||
<a class=nav-link id=dafcebTab data-bs-toggle=tab data-bs-target=#dafceb type=button role=tab aria-controls=dafceb aria-selected=true>响应示例</a></div></nav><div class=tab-content id=nav-tab-content><div class="tab-pane fade show active" id=edcafb role=tabpanel aria-labelledby=nav-1><div class=prism-codeblock><pre id=dad2714 class=language-bash>
|
||
<code>curl --location --request PUT 'http://localhost:3000/api/core/dataset/data/update' \
|
||
--header 'Authorization: Bearer {{authorization}}' \
|
||
--header 'Content-Type: application/json' \
|
||
--data-raw '{
|
||
"dataId":"65abd4b29d1448617cba61db",
|
||
"q":"测试111",
|
||
"a":"sss",
|
||
"indexes":[
|
||
{
|
||
"dataId": "xxxx",
|
||
"type": "default",
|
||
"text": "默认索引"
|
||
},
|
||
{
|
||
"dataId": "xxx",
|
||
"type": "custom",
|
||
"text": "旧的自定义索引1"
|
||
},
|
||
{
|
||
"type":"custom",
|
||
"text":"新增的自定义索引"
|
||
}
|
||
]
|
||
}'</code>
|
||
</pre></div></div><div class="tab-pane fade" id=cfdbae role=tabpanel aria-labelledby=nav-1><div class="alert alert-success d-flex" role=alert><div class="flex-shrink-1 alert-icon"></div><div class=w-100><ul><li>dataId: 数据的id</li><li>q: 主要数据（选填）</li><li>a: 辅助数据（选填）</li><li>indexes: 自定义索引（选填），类型参考<code>为集合批量添加添加数据</code>。如果创建时候有自定义索引，</li></ul></div></div></div><div class="tab-pane fade" id=dafceb role=tabpanel aria-labelledby=nav-1><div class=prism-codeblock><pre id=110f134 class=language-json>
|
||
<code>{
|
||
"code": 200,
|
||
"statusText": "",
|
||
"message": "",
|
||
"data": null
|
||
}</code>
|
||
</pre></div></div></div><h3 id=删除单条数据>删除单条数据 <a href=#%e5%88%a0%e9%99%a4%e5%8d%95%e6%9d%a1%e6%95%b0%e6%8d%ae class=anchor aria-hidden=true><i class="material-icons align-middle">link</i></a></h3><nav><div class="nav nav-tabs" id=nav-tab role=tablist><a class="nav-link active" id=afedbcTab data-bs-toggle=tab data-bs-target=#afedbc type=button role=tab aria-controls=afedbc aria-selected=true>请求示例</a>
|
||
<a class=nav-link id=cbfedaTab data-bs-toggle=tab data-bs-target=#cbfeda type=button role=tab aria-controls=cbfeda aria-selected=true>参数说明</a>
|
||
<a class=nav-link id=cbaefdTab data-bs-toggle=tab data-bs-target=#cbaefd type=button role=tab aria-controls=cbaefd aria-selected=true>响应示例</a></div></nav><div class=tab-content id=nav-tab-content><div class="tab-pane fade show active" id=afedbc role=tabpanel aria-labelledby=nav-1><div class=prism-codeblock><pre id=eb08cc2 class=language-bash>
|
||
<code>curl --location --request DELETE 'http://localhost:3000/api/core/dataset/data/delete?id=65abd4b39d1448617cba624d' \
|
||
--header 'Authorization: Bearer {{authorization}}' \</code>
|
||
</pre></div></div><div class="tab-pane fade" id=cbfeda role=tabpanel aria-labelledby=nav-1><div class="alert alert-success d-flex" role=alert><div class="flex-shrink-1 alert-icon"></div><div class=w-100><ul><li>id: 数据的id</li></ul></div></div></div><div class="tab-pane fade" id=cbaefd role=tabpanel aria-labelledby=nav-1><div class=prism-codeblock><pre id=3273df7 class=language-json>
|
||
<code>{
|
||
"code": 200,
|
||
"statusText": "",
|
||
"message": "",
|
||
"data": "success"
|
||
}</code>
|
||
</pre></div></div></div><h2 id=搜索测试>搜索测试 <a href=#%e6%90%9c%e7%b4%a2%e6%b5%8b%e8%af%95 class=anchor aria-hidden=true><i class="material-icons align-middle">link</i></a></h2><nav><div class="nav nav-tabs" id=nav-tab role=tablist><a class="nav-link active" id=aecfbdTab data-bs-toggle=tab data-bs-target=#aecfbd type=button role=tab aria-controls=aecfbd aria-selected=true>请求示例</a>
|
||
<a class=nav-link id=efdcabTab data-bs-toggle=tab data-bs-target=#efdcab type=button role=tab aria-controls=efdcab aria-selected=true>参数说明</a>
|
||
<a class=nav-link id=adcfebTab data-bs-toggle=tab data-bs-target=#adcfeb type=button role=tab aria-controls=adcfeb aria-selected=true>响应示例</a></div></nav><div class=tab-content id=nav-tab-content><div class="tab-pane fade show active" id=aecfbd role=tabpanel aria-labelledby=nav-1><div class=prism-codeblock><pre id=479fc3d class=language-bash>
|
||
<code>curl --location --request POST 'https://api.fastgpt.in/api/core/dataset/searchTest' \
|
||
--header 'Authorization: Bearer fastgpt-xxxxx' \
|
||
--header 'Content-Type: application/json' \
|
||
--data-raw '{
|
||
"datasetId": "知识库的ID",
|
||
"text": "导演是谁",
|
||
"limit": 5000,
|
||
"similarity": 0,
|
||
"searchMode": "embedding",
|
||
"usingReRank": false,
|
||
|
||
"datasetSearchUsingExtensionQuery": true,
|
||
"datasetSearchExtensionModel": "gpt-4o-mini",
|
||
"datasetSearchExtensionBg": ""
|
||
}'</code>
|
||
</pre></div></div><div class="tab-pane fade" id=efdcab role=tabpanel aria-labelledby=nav-1><div class="alert alert-success d-flex" role=alert><div class="flex-shrink-1 alert-icon"></div><div class=w-100><ul><li>datasetId - 知识库ID</li><li>text - 需要测试的文本</li><li>limit - 最大 tokens 数量</li><li>similarity - 最低相关度（0~1，可选）</li><li>searchMode - 搜索模式：embedding | fullTextRecall | mixedRecall</li><li>usingReRank - 使用重排</li><li>datasetSearchUsingExtensionQuery - 使用问题优化</li><li>datasetSearchExtensionModel - 问题优化模型</li><li>datasetSearchExtensionBg - 问题优化背景描述</li></ul></div></div></div><div class="tab-pane fade" id=adcfeb role=tabpanel aria-labelledby=nav-1><p>返回 top k 结果， limit 为最大 Tokens 数量，最多 20000 tokens。</p><div class=prism-codeblock><pre id=ad5c5b4 class=language-json>
|
||
<code>{
|
||
"code": 200,
|
||
"statusText": "",
|
||
"data": [
|
||
{
|
||
"id": "65599c54a5c814fb803363cb",
|
||
"q": "你是谁",
|
||
"a": "我是FastGPT助手",
|
||
"datasetId": "6554684f7f9ed18a39a4d15c",
|
||
"collectionId": "6556cd795e4b663e770bb66d",
|
||
"sourceName": "GBT 15104-2021 装饰单板贴面人造板.pdf",
|
||
"sourceId": "6556cd775e4b663e770bb65c",
|
||
"score": 0.8050316572189331
|
||
},
|
||
......
|
||
]
|
||
}</code>
|
||
</pre></div></div></div></div><div class="gitinfo d-flex flex-wrap justify-content-between align-items-center opacity-85 pt-3"><div id=edit-this-page class=mt-1><a href=https://github.com/labring/FastGPT/blob/main/docSite/content/zh-cn/docs/development/openapi/dataset.md alt=知识库接口 rel="noopener noreferrer" target=_blank><span class="me-1 align-text-bottom"><svg width="20" height="20" viewBox="0 0 32 32" xmlns="http://www.w3.org/2000/svg" fill="currentcolor"><path d="M16 .396c-8.839.0-16 7.167-16 16 0 7.073 4.584 13.068 10.937 15.183.803.151 1.093-.344 1.093-.772.0-.38-.009-1.385-.015-2.719-4.453.964-5.391-2.151-5.391-2.151-.729-1.844-1.781-2.339-1.781-2.339-1.448-.989.115-.968.115-.968 1.604.109 2.448 1.645 2.448 1.645 1.427 2.448 3.744 1.74 4.661 1.328.14-1.031.557-1.74 1.011-2.135-3.552-.401-7.287-1.776-7.287-7.907.0-1.751.62-3.177 1.645-4.297-.177-.401-.719-2.031.141-4.235.0.0 1.339-.427 4.4 1.641 1.281-.355 2.641-.532 4-.541 1.36.009 2.719.187 4 .541 3.043-2.068 4.381-1.641 4.381-1.641.859 2.204.317 3.833.161 4.235 1.015 1.12 1.635 2.547 1.635 4.297.0 6.145-3.74 7.5-7.296 7.891.556.479 1.077 1.464 1.077 2.959.0 2.14-.02 3.864-.02 4.385.0.416.28.916 1.104.755 6.4-2.093 10.979-8.093 10.979-15.156.0-8.833-7.161-16-16-16z"/></svg></span>编辑此页面</a></div></div></div><div><hr class=doc-hr><div id=doc-nav class=d-print-none><div class="row flex-xl-nowrap"><div class="col-sm-6 pt-2 doc-next"><a href=/docs/development/openapi/chat/><div class="card h-100 my-1"><div class="card-body py-2"><p class="card-title fs-5 fw-semibold lh-base mb-0"><i class="material-icons align-middle">navigate_before</i> 对话接口</p><p class="card-text ms-2">FastGPT OpenAPI 对话接口</p></div></div></a></div><div class="col-sm-6 pt-2 doc-prev"><a class=ms-auto href=/docs/development/openapi/share/><div class="card h-100 my-1 text-end"><div class="card-body py-2"><p class="card-title fs-5 fw-semibold lh-base mb-0">分享链接身份鉴权 <i class="material-icons align-middle">navigate_next</i></p><p class="card-text me-2">FastGPT 分享链接身份鉴权</p></div></div></a></div></div></div></div></div></div></div></div><footer class="shadow py-3 d-print-none"><div class="row align-items-center" style=height:90px><div class=col><div class="text-sm-start text-center mx-md-2"><p class=mb-0>© 2025 the FastGPT Authors.</p><p class=github-badge><span class=badge-subject>云操作系统</span><span class="badge-value bg-blue"><a style=color:#fff href=https://sealos.io/ target=_blank>Sealos</a></span>
|
||
<span class=badge-subject>云开发</span><span class="badge-value bg-brightgreen"><a style=color:#fff href=https://laf.run target=_blank>Laf</a></span>
|
||
<span class=badge-subject>云原生存储</span><span class="badge-value bg-orange"><a style=color:#fff href=https://github.com/labring/sealfs target=_blank>Sealfs</a></span></p><div id=fixed-box><div class=feedback-btn-wrapper><a href=https://fael3z0zfze.feishu.cn/share/base/form/shrcnRxj3utrzjywsom96Px4sud style=text-decoration:none target=_blank><button id=feedback-btn title="Give feedback"><svg class="inline w-5 h-5" viewBox="0 0 20 20" fill="currentcolor"><path fill-rule="evenodd" d="M18 13V5a2 2 0 00-2-2H4A2 2 0 002 5v8a2 2 0 002 2h3l3 3 3-3h3a2 2 0 002-2zM5 7a1 1 0 011-1h8a1 1 0 110 2H6A1 1 0 015 7zm1 3a1 1 0 100 2h3a1 1 0 100-2H6z" clip-rule="evenodd"/></svg>
|
||
<span _msttexthash=6039839 _msthash=295>咨询合作</span></button></a></div></div></div></div></div></footer></main></div></div><button onclick=topFunction() id=back-to-top aria-label="Back to Top Button" class="back-to-top fs-5"><svg width="24" height="24"><path d="M12 10.224l-6.3 6.3-1.38-1.372L12 7.472l7.68 7.68-1.38 1.376z" style="fill:#fff"/></svg></button>
|
||
<script>(()=>{var e=document.getElementById("mode");e!==null&&(window.matchMedia("(prefers-color-scheme: dark)").addEventListener("change",e=>{e.matches?(localStorage.setItem("theme","dark"),document.documentElement.setAttribute("data-dark-mode","")):(localStorage.setItem("theme","light"),document.documentElement.removeAttribute("data-dark-mode"))}),e.addEventListener("click",()=>{document.documentElement.toggleAttribute("data-dark-mode"),localStorage.setItem("theme",document.documentElement.hasAttribute("data-dark-mode")?"dark":"light")}),localStorage.getItem("theme")==="dark"?document.documentElement.setAttribute("data-dark-mode",""):document.documentElement.removeAttribute("data-dark-mode"))})()</script><script src=/docs/js/bootstrap.58faa4dc6cac13820c8a72b1fdd5d716641b3129ef981b1956fa23d69ad59f180fed6d42cb92030ac272ba85e7f8247d.js integrity=sha384-WPqk3GysE4IMinKx/dXXFmQbMSnvmBsZVvoj1prVnxgP7W1Cy5IDCsJyuoXn+CR9 defer></script>
|
||
<script type=text/javascript src=https://doc.tryfastgpt.ai/docs/js/bundle.min.68e80f383e0615acc689eae489a8c1d728bea3861d874ec1044cc85566fd9ff1b10385a1feadd324701c587f66e425bc.js integrity=sha384-aOgPOD4GFazGierkiajB1yi+o4Ydh07BBEzIVWb9n/GxA4Wh/q3TJHAcWH9m5CW8 crossorigin=anonymous defer></script>
|
||
<script src=https://cdn.jsdelivr.net/npm/medium-zoom/dist/medium-zoom.min.js crossorigin=anonymous referrerpolicy=no-referrer></script>
|
||
<script>const images=Array.from(document.querySelectorAll(".medium-zoom-image"));images.forEach(e=>{mediumZoom(e,{margin:0,scrollOffset:40,container:null,template:null,background:"rgba(0, 0, 0, 0.8)"})})</script><script>window.addEventListener("DOMContentLoaded",function(){docsearch({container:"#docsearch",appId:"5BEWEMH0YA",apiKey:"14834e919a87217d919d6d881fcacac3",indexName:"fastgpt",placeholder:"搜索",translations:{button:{buttonText:"搜索",buttonAriaLabel:"搜索"},modal:{startScreen:{noRecentSearchesText:"没有最近搜索"},footer:{selectText:"选中",selectKeyAriaLabel:"Enter key",navigateText:"导航",navigateUpKeyAriaLabel:"Arrow up",navigateDownKeyAriaLabel:"Arrow down",closeText:"关闭",closeKeyAriaLabel:"Escape key",searchByText:"搜索提供"},noResultsScreen:{noResultsText:"没有结果：",suggestedQueryText:"试试搜索",reportMissingResultsText:"Believe this query should return results?",reportMissingResultsLinkText:"Let us know."}}}})})</script></body></html> |