gitea/FastGPT
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

deploy: b4aeaf10ae7adb69d89a4b0cf0f26a333b6accc7

Browse Source
This commit is contained in:
c121914yu 2025-04-18 06:47:52 +00:00
parent 0af33234af
commit 462d52ee3e
8 changed files with 222 additions and 222 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/development/docker/index.html
View File

File diff suppressed because one or more lines are too long

18
docs/development/faq/index.html
View File

File diff suppressed because one or more lines are too long

150
docs/development/openapi/chat/index.html
View File

File diff suppressed because one or more lines are too long

170
docs/development/openapi/dataset/index.html
View File

File diff suppressed because one or more lines are too long

30
docs/development/openapi/share/index.html
View File

@ -43,43 +43,43 @@ Table of Contents</button><nav id=toc-mobile><ul class=dropdown-menu><li><ul><li
&#34;uid&#34;: &#34;用户唯一凭证&#34; &#34;uid&#34;: &#34;用户唯一凭证&#34;
} }
}</code> }</code>
</pre></div><p><code>FastGPT</code> 将会判断<code>success</code>是否为<code>true</code>决定是允许用户继续操作。<code>message</code>与<code>msg</code>是等同的，你可以选择返回其中一个，当<code>success</code>不为<code>true</code>时，将会提示这个错误。</p><p><code>uid</code>是用户的唯一凭证，将会用于拉取对话记录以及保存对话记录。可参考下方实践案例。</p><h3 id=触发流程>触发流程 <a href=#%e8%a7%a6%e5%8f%91%e6%b5%81%e7%a8%8b class=anchor aria-hidden=true><i class="material-icons align-middle">link</i></a></h3><p><img src=https://cdn.jsdelivr.net/gh/yangchuansheng/fastgpt-imgs@main/imgs/sharelink_process.png alt loading=lazy class=medium-zoom-image></p><h2 id=配置教程>配置教程 <a href=#%e9%85%8d%e7%bd%ae%e6%95%99%e7%a8%8b class=anchor aria-hidden=true><i class="material-icons align-middle">link</i></a></h2><h3 id=1-配置身份校验地址>1. 配置身份校验地址 <a href=#1-%e9%85%8d%e7%bd%ae%e8%ba%ab%e4%bb%bd%e6%a0%a1%e9%aa%8c%e5%9c%b0%e5%9d%80 class=anchor aria-hidden=true><i class="material-icons align-middle">link</i></a></h3><p><img src=https://cdn.jsdelivr.net/gh/yangchuansheng/fastgpt-imgs@main/imgs/share-setlink.png alt loading=lazy class=medium-zoom-image></p><p>配置校验地址后，在每次分享链接使用时，都会向对应的地址发起校验和上报请求。</p><div class="alert alert-default d-flex" role=alert><div class="flex-shrink-1 alert-icon"><p>🤖</p></div><div class=w-100><p>这里仅需配置根地址，无需具体到完整请求路径。</p></div></div><h3 id=2-分享链接中增加额外-query>2. 分享链接中增加额外 query <a href=#2-%e5%88%86%e4%ba%ab%e9%93%be%e6%8e%a5%e4%b8%ad%e5%a2%9e%e5%8a%a0%e9%a2%9d%e5%a4%96-query class=anchor aria-hidden=true><i class="material-icons align-middle">link</i></a></h3><p>在分享链接的地址中，增加一个额外的参数: authToken。例如：</p><p>原始的链接：<code>https://share.tryfastgpt.ai/chat/share?shareId=648aaf5ae121349a16d62192</code></p><p>完整链接: <code>https://share.tryfastgpt.ai/chat/share?shareId=648aaf5ae121349a16d62192&amp;authToken=userid12345</code></p><p>这个<code>authToken</code>通常是你系统生成的用户唯一凭证（Token之类的）。FastGPT 会在鉴权接口的<code>body</code>中携带 token={{authToken}} 的参数。</p><h3 id=3-编写聊天初始化校验接口>3. 编写聊天初始化校验接口 <a href=#3-%e7%bc%96%e5%86%99%e8%81%8a%e5%a4%a9%e5%88%9d%e5%a7%8b%e5%8c%96%e6%a0%a1%e9%aa%8c%e6%8e%a5%e5%8f%a3 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=dabecfTab data-bs-toggle=tab data-bs-target=#dabecf type=button role=tab aria-controls=dabecf aria-selected=true>请求示例</a> </pre></div><p><code>FastGPT</code> 将会判断<code>success</code>是否为<code>true</code>决定是允许用户继续操作。<code>message</code>与<code>msg</code>是等同的，你可以选择返回其中一个，当<code>success</code>不为<code>true</code>时，将会提示这个错误。</p><p><code>uid</code>是用户的唯一凭证，将会用于拉取对话记录以及保存对话记录。可参考下方实践案例。</p><h3 id=触发流程>触发流程 <a href=#%e8%a7%a6%e5%8f%91%e6%b5%81%e7%a8%8b class=anchor aria-hidden=true><i class="material-icons align-middle">link</i></a></h3><p><img src=https://cdn.jsdelivr.net/gh/yangchuansheng/fastgpt-imgs@main/imgs/sharelink_process.png alt loading=lazy class=medium-zoom-image></p><h2 id=配置教程>配置教程 <a href=#%e9%85%8d%e7%bd%ae%e6%95%99%e7%a8%8b class=anchor aria-hidden=true><i class="material-icons align-middle">link</i></a></h2><h3 id=1-配置身份校验地址>1. 配置身份校验地址 <a href=#1-%e9%85%8d%e7%bd%ae%e8%ba%ab%e4%bb%bd%e6%a0%a1%e9%aa%8c%e5%9c%b0%e5%9d%80 class=anchor aria-hidden=true><i class="material-icons align-middle">link</i></a></h3><p><img src=https://cdn.jsdelivr.net/gh/yangchuansheng/fastgpt-imgs@main/imgs/share-setlink.png alt loading=lazy class=medium-zoom-image></p><p>配置校验地址后，在每次分享链接使用时，都会向对应的地址发起校验和上报请求。</p><div class="alert alert-default d-flex" role=alert><div class="flex-shrink-1 alert-icon"><p>🤖</p></div><div class=w-100><p>这里仅需配置根地址，无需具体到完整请求路径。</p></div></div><h3 id=2-分享链接中增加额外-query>2. 分享链接中增加额外 query <a href=#2-%e5%88%86%e4%ba%ab%e9%93%be%e6%8e%a5%e4%b8%ad%e5%a2%9e%e5%8a%a0%e9%a2%9d%e5%a4%96-query class=anchor aria-hidden=true><i class="material-icons align-middle">link</i></a></h3><p>在分享链接的地址中，增加一个额外的参数: authToken。例如：</p><p>原始的链接：<code>https://share.tryfastgpt.ai/chat/share?shareId=648aaf5ae121349a16d62192</code></p><p>完整链接: <code>https://share.tryfastgpt.ai/chat/share?shareId=648aaf5ae121349a16d62192&amp;authToken=userid12345</code></p><p>这个<code>authToken</code>通常是你系统生成的用户唯一凭证（Token之类的）。FastGPT 会在鉴权接口的<code>body</code>中携带 token={{authToken}} 的参数。</p><h3 id=3-编写聊天初始化校验接口>3. 编写聊天初始化校验接口 <a href=#3-%e7%bc%96%e5%86%99%e8%81%8a%e5%a4%a9%e5%88%9d%e5%a7%8b%e5%8c%96%e6%a0%a1%e9%aa%8c%e6%8e%a5%e5%8f%a3 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=ebfcdaTab data-bs-toggle=tab data-bs-target=#ebfcda type=button role=tab aria-controls=ebfcda aria-selected=true>请求示例</a>
<a class=nav-link id=dceafbTab data-bs-toggle=tab data-bs-target=#dceafb type=button role=tab aria-controls=dceafb aria-selected=true>鉴权成功</a> <a class=nav-link id=dcfaebTab data-bs-toggle=tab data-bs-target=#dcfaeb type=button role=tab aria-controls=dcfaeb aria-selected=true>鉴权成功</a>
<a class=nav-link id=abdcefTab data-bs-toggle=tab data-bs-target=#abdcef type=button role=tab aria-controls=abdcef aria-selected=true>鉴权失败</a></div></nav><div class=tab-content id=nav-tab-content><div class="tab-pane fade show active" id=dabecf role=tabpanel aria-labelledby=nav-1><div class=prism-codeblock><pre id=39d214b class=language-bash> <a class=nav-link id=cebadfTab data-bs-toggle=tab data-bs-target=#cebadf type=button role=tab aria-controls=cebadf aria-selected=true>鉴权失败</a></div></nav><div class=tab-content id=nav-tab-content><div class="tab-pane fade show active" id=ebfcda role=tabpanel aria-labelledby=nav-1><div class=prism-codeblock><pre id=39d214b class=language-bash>
<code>curl --location --request POST &#39;{{host}}/shareAuth/init&#39; \ <code>curl --location --request POST &#39;{{host}}/shareAuth/init&#39; \
--header &#39;Content-Type: application/json&#39; \ --header &#39;Content-Type: application/json&#39; \
--data-raw &#39;{ --data-raw &#39;{
&#34;token&#34;: &#34;{{authToken}}&#34; &#34;token&#34;: &#34;{{authToken}}&#34;
}&#39;</code> }&#39;</code>
</pre></div></div><div class="tab-pane fade" id=dceafb role=tabpanel aria-labelledby=nav-1><div class=prism-codeblock><pre id=d6c7899 class=language-json> </pre></div></div><div class="tab-pane fade" id=dcfaeb role=tabpanel aria-labelledby=nav-1><div class=prism-codeblock><pre id=d6c7899 class=language-json>
<code>{ <code>{
&#34;success&#34;: true, &#34;success&#34;: true,
&#34;data&#34;: { &#34;data&#34;: {
&#34;uid&#34;: &#34;用户唯一凭证&#34; &#34;uid&#34;: &#34;用户唯一凭证&#34;
} }
}</code> }</code>
</pre></div><p>系统会拉取该分享链接下，uid 为 username123 的对话记录。</p></div><div class="tab-pane fade" id=abdcef role=tabpanel aria-labelledby=nav-1><div class=prism-codeblock><pre id=3297f92 class=language-json> </pre></div><p>系统会拉取该分享链接下，uid 为 username123 的对话记录。</p></div><div class="tab-pane fade" id=cebadf role=tabpanel aria-labelledby=nav-1><div class=prism-codeblock><pre id=3297f92 class=language-json>
<code>{ <code>{
&#34;success&#34;: false, &#34;success&#34;: false,
&#34;message&#34;: &#34;身份错误&#34;, &#34;message&#34;: &#34;身份错误&#34;,
}</code> }</code>
</pre></div></div></div><h3 id=4-编写对话前校验接口>4. 编写对话前校验接口 <a href=#4-%e7%bc%96%e5%86%99%e5%af%b9%e8%af%9d%e5%89%8d%e6%a0%a1%e9%aa%8c%e6%8e%a5%e5%8f%a3 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=dfacbeTab data-bs-toggle=tab data-bs-target=#dfacbe type=button role=tab aria-controls=dfacbe aria-selected=true>请求示例</a> </pre></div></div></div><h3 id=4-编写对话前校验接口>4. 编写对话前校验接口 <a href=#4-%e7%bc%96%e5%86%99%e5%af%b9%e8%af%9d%e5%89%8d%e6%a0%a1%e9%aa%8c%e6%8e%a5%e5%8f%a3 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=ecfadbTab data-bs-toggle=tab data-bs-target=#ecfadb type=button role=tab aria-controls=ecfadb aria-selected=true>请求示例</a>
<a class=nav-link id=deabfcTab data-bs-toggle=tab data-bs-target=#deabfc type=button role=tab aria-controls=deabfc aria-selected=true>鉴权成功</a> <a class=nav-link id=eafbdcTab data-bs-toggle=tab data-bs-target=#eafbdc type=button role=tab aria-controls=eafbdc aria-selected=true>鉴权成功</a>
<a class=nav-link id=bfaecdTab data-bs-toggle=tab data-bs-target=#bfaecd type=button role=tab aria-controls=bfaecd aria-selected=true>鉴权失败</a></div></nav><div class=tab-content id=nav-tab-content><div class="tab-pane fade show active" id=dfacbe role=tabpanel aria-labelledby=nav-1><div class=prism-codeblock><pre id=40c1d59 class=language-bash> <a class=nav-link id=cefadbTab data-bs-toggle=tab data-bs-target=#cefadb type=button role=tab aria-controls=cefadb aria-selected=true>鉴权失败</a></div></nav><div class=tab-content id=nav-tab-content><div class="tab-pane fade show active" id=ecfadb role=tabpanel aria-labelledby=nav-1><div class=prism-codeblock><pre id=40c1d59 class=language-bash>
<code>curl --location --request POST &#39;{{host}}/shareAuth/start&#39; \ <code>curl --location --request POST &#39;{{host}}/shareAuth/start&#39; \
--header &#39;Content-Type: application/json&#39; \ --header &#39;Content-Type: application/json&#39; \
--data-raw &#39;{ --data-raw &#39;{
&#34;token&#34;: &#34;{{authToken}}&#34;, &#34;token&#34;: &#34;{{authToken}}&#34;,
&#34;question&#34;: &#34;用户问题&#34;, &#34;question&#34;: &#34;用户问题&#34;,
}&#39;</code> }&#39;</code>
</pre></div></div><div class="tab-pane fade" id=deabfc role=tabpanel aria-labelledby=nav-1><div class=prism-codeblock><pre id=d6c7899 class=language-json> </pre></div></div><div class="tab-pane fade" id=eafbdc role=tabpanel aria-labelledby=nav-1><div class=prism-codeblock><pre id=d6c7899 class=language-json>
<code>{ <code>{
&#34;success&#34;: true, &#34;success&#34;: true,
&#34;data&#34;: { &#34;data&#34;: {
&#34;uid&#34;: &#34;用户唯一凭证&#34; &#34;uid&#34;: &#34;用户唯一凭证&#34;
} }
}</code> }</code>
</pre></div></div><div class="tab-pane fade" id=bfaecd role=tabpanel aria-labelledby=nav-1><div class=prism-codeblock><pre id=23a56e7 class=language-json> </pre></div></div><div class="tab-pane fade" id=cefadb role=tabpanel aria-labelledby=nav-1><div class=prism-codeblock><pre id=23a56e7 class=language-json>
<code>{ <code>{
&#34;success&#34;: false, &#34;success&#34;: false,
&#34;message&#34;: &#34;身份验证失败&#34;, &#34;message&#34;: &#34;身份验证失败&#34;,
@ -202,9 +202,9 @@ Table of Contents</button><nav id=toc-mobile><ul class=dropdown-menu><li><ul><li
isElseResult?: boolean; // 判断器结果 isElseResult?: boolean; // 判断器结果
}</code> }</code>
</pre></div><h2 id=实践案例>实践案例 <a href=#%e5%ae%9e%e8%b7%b5%e6%a1%88%e4%be%8b class=anchor aria-hidden=true><i class="material-icons align-middle">link</i></a></h2><p>我们以<a href=https://laf.dev/ rel=external target=_blank>Laf作为服务器为例<svg width="16" height="16" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path fill="currentcolor" d="M14 5c-.552.0-1-.448-1-1s.448-1 1-1h6c.552.0 1 .448 1 1v6c0 .552-.448 1-1 1s-1-.448-1-1V6.414l-7.293 7.293c-.391.39-1.024.39-1.414.0-.391-.391-.391-1.024.0-1.414L17.586 5H14zM5 7c-.552.0-1 .448-1 1v11c0 .552.448 1 1 1h11c.552.0 1-.448 1-1v-4.563c0-.552.448-1 1-1s1 .448 1 1V19c0 1.657-1.343 3-3 3H5c-1.657.0-3-1.343-3-3V8c0-1.657 1.343-3 3-3h4.563c.552.0 1 .448 1 1s-.448 1-1 1H5z"/></svg></a>，简单展示这 3 个接口的使用方式。</p><h3 id=1-创建3个laf接口>1. 创建3个Laf接口 <a href=#1-%e5%88%9b%e5%bb%ba3%e4%b8%aalaf%e6%8e%a5%e5%8f%a3 class=anchor aria-hidden=true><i class="material-icons align-middle">link</i></a></h3><p><img src=https://cdn.jsdelivr.net/gh/yangchuansheng/fastgpt-imgs@main/imgs/share-auth1.png alt loading=lazy class=medium-zoom-image></p><nav><div class="nav nav-tabs" id=nav-tab role=tablist><a class="nav-link active" id=dcaefbTab data-bs-toggle=tab data-bs-target=#dcaefb type=button role=tab aria-controls=dcaefb aria-selected=true>/shareAuth/init</a> </pre></div><h2 id=实践案例>实践案例 <a href=#%e5%ae%9e%e8%b7%b5%e6%a1%88%e4%be%8b class=anchor aria-hidden=true><i class="material-icons align-middle">link</i></a></h2><p>我们以<a href=https://laf.dev/ rel=external target=_blank>Laf作为服务器为例<svg width="16" height="16" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path fill="currentcolor" d="M14 5c-.552.0-1-.448-1-1s.448-1 1-1h6c.552.0 1 .448 1 1v6c0 .552-.448 1-1 1s-1-.448-1-1V6.414l-7.293 7.293c-.391.39-1.024.39-1.414.0-.391-.391-.391-1.024.0-1.414L17.586 5H14zM5 7c-.552.0-1 .448-1 1v11c0 .552.448 1 1 1h11c.552.0 1-.448 1-1v-4.563c0-.552.448-1 1-1s1 .448 1 1V19c0 1.657-1.343 3-3 3H5c-1.657.0-3-1.343-3-3V8c0-1.657 1.343-3 3-3h4.563c.552.0 1 .448 1 1s-.448 1-1 1H5z"/></svg></a>，简单展示这 3 个接口的使用方式。</p><h3 id=1-创建3个laf接口>1. 创建3个Laf接口 <a href=#1-%e5%88%9b%e5%bb%ba3%e4%b8%aalaf%e6%8e%a5%e5%8f%a3 class=anchor aria-hidden=true><i class="material-icons align-middle">link</i></a></h3><p><img src=https://cdn.jsdelivr.net/gh/yangchuansheng/fastgpt-imgs@main/imgs/share-auth1.png alt loading=lazy class=medium-zoom-image></p><nav><div class="nav nav-tabs" id=nav-tab role=tablist><a class="nav-link active" id=cafbdeTab data-bs-toggle=tab data-bs-target=#cafbde type=button role=tab aria-controls=cafbde aria-selected=true>/shareAuth/init</a>
<a class=nav-link id=fbdaceTab data-bs-toggle=tab data-bs-target=#fbdace type=button role=tab aria-controls=fbdace aria-selected=true>/shareAuth/start</a> <a class=nav-link id=fedabcTab data-bs-toggle=tab data-bs-target=#fedabc type=button role=tab aria-controls=fedabc aria-selected=true>/shareAuth/start</a>
<a class=nav-link id=fbacdeTab data-bs-toggle=tab data-bs-target=#fbacde type=button role=tab aria-controls=fbacde aria-selected=true>/shareAuth/finish</a></div></nav><div class=tab-content id=nav-tab-content><div class="tab-pane fade show active" id=dcaefb role=tabpanel aria-labelledby=nav-1><p>这个接口中，我们设置了<code>token</code>必须等于<code>fastgpt</code>才能通过校验。（实际生产中不建议固定写死）</p><div class=prism-codeblock><pre id=ba0b6c9 class=language-ts> <a class=nav-link id=febadcTab data-bs-toggle=tab data-bs-target=#febadc type=button role=tab aria-controls=febadc aria-selected=true>/shareAuth/finish</a></div></nav><div class=tab-content id=nav-tab-content><div class="tab-pane fade show active" id=cafbde role=tabpanel aria-labelledby=nav-1><p>这个接口中，我们设置了<code>token</code>必须等于<code>fastgpt</code>才能通过校验。（实际生产中不建议固定写死）</p><div class=prism-codeblock><pre id=ba0b6c9 class=language-ts>
<code>import cloud from &#39;@lafjs/cloud&#39; <code>import cloud from &#39;@lafjs/cloud&#39;
export default async function (ctx: FunctionContext) { export default async function (ctx: FunctionContext) {
@ -217,7 +217,7 @@ export default async function (ctx: FunctionContext) {
return { success: false,message:&#34;身份错误&#34; } return { success: false,message:&#34;身份错误&#34; }
}</code> }</code>
</pre></div></div><div class="tab-pane fade" id=fbdace role=tabpanel aria-labelledby=nav-1><p>这个接口中，我们设置了<code>token</code>必须等于<code>fastgpt</code>才能通过校验。并且如果问题中包含了<code>你</code>字，则会报错，用于模拟敏感校验。</p><div class=prism-codeblock><pre id=cf82db5 class=language-ts> </pre></div></div><div class="tab-pane fade" id=fedabc role=tabpanel aria-labelledby=nav-1><p>这个接口中，我们设置了<code>token</code>必须等于<code>fastgpt</code>才能通过校验。并且如果问题中包含了<code>你</code>字，则会报错，用于模拟敏感校验。</p><div class=prism-codeblock><pre id=cf82db5 class=language-ts>
<code>import cloud from &#39;@lafjs/cloud&#39; <code>import cloud from &#39;@lafjs/cloud&#39;
export default async function (ctx: FunctionContext) { export default async function (ctx: FunctionContext) {
@ -235,7 +235,7 @@ export default async function (ctx: FunctionContext) {
return { success: true, data: { uid: &#34;user1&#34; } } return { success: true, data: { uid: &#34;user1&#34; } }
}</code> }</code>
</pre></div></div><div class="tab-pane fade" id=fbacde role=tabpanel aria-labelledby=nav-1><p>结果上报接口可自行进行逻辑处理。</p><div class=prism-codeblock><pre id=b3696df class=language-ts> </pre></div></div><div class="tab-pane fade" id=febadc role=tabpanel aria-labelledby=nav-1><p>结果上报接口可自行进行逻辑处理。</p><div class=prism-codeblock><pre id=b3696df class=language-ts>
<code>import cloud from &#39;@lafjs/cloud&#39; <code>import cloud from &#39;@lafjs/cloud&#39;
export default async function (ctx: FunctionContext) { export default async function (ctx: FunctionContext) {

24
docs/guide/admin/sso/index.html
View File

@ -160,12 +160,12 @@ Table of Contents</button><nav id=toc-mobile><ul class=dropdown-menu><li><ul><li
- OAUTH2_MEMBER_NAME_MAP= - OAUTH2_MEMBER_NAME_MAP=
# OAuth2 联系方式字段映射(选填) # OAuth2 联系方式字段映射(选填)
- OAUTH2_CONTACT_MAP=</code> - OAUTH2_CONTACT_MAP=</code>
</pre></div><h2 id=标准接口文档>标准接口文档 <a href=#%e6%a0%87%e5%87%86%e6%8e%a5%e5%8f%a3%e6%96%87%e6%a1%a3 class=anchor aria-hidden=true><i class="material-icons align-middle">link</i></a></h2><p>以下是 FastGPT-pro 中，SSO 和成员同步的标准接口文档，如果需要对接非标准系统，可以参考该章节进行开发。</p><p><img src=https://cdn.jsdelivr.net/gh/yangchuansheng/fastgpt-imgs@main/imgs/sso18.png alt loading=lazy class=medium-zoom-image></p><p>FastGPT 提供如下标准接口支持：</p><ol><li><a href=https://example.com/login/oauth/getAuthURL rel=external target=_blank>https://example.com/login/oauth/getAuthURL<svg width="16" height="16" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path fill="currentcolor" d="M14 5c-.552.0-1-.448-1-1s.448-1 1-1h6c.552.0 1 .448 1 1v6c0 .552-.448 1-1 1s-1-.448-1-1V6.414l-7.293 7.293c-.391.39-1.024.39-1.414.0-.391-.391-.391-1.024.0-1.414L17.586 5H14zM5 7c-.552.0-1 .448-1 1v11c0 .552.448 1 1 1h11c.552.0 1-.448 1-1v-4.563c0-.552.448-1 1-1s1 .448 1 1V19c0 1.657-1.343 3-3 3H5c-1.657.0-3-1.343-3-3V8c0-1.657 1.343-3 3-3h4.563c.552.0 1 .448 1 1s-.448 1-1 1H5z"/></svg></a> 获取鉴权重定向地址</li><li><a href="https://example.com/login/oauth/getUserInfo?code=xxxxx" rel=external target=_blank>https://example.com/login/oauth/getUserInfo?code=xxxxx<svg width="16" height="16" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path fill="currentcolor" d="M14 5c-.552.0-1-.448-1-1s.448-1 1-1h6c.552.0 1 .448 1 1v6c0 .552-.448 1-1 1s-1-.448-1-1V6.414l-7.293 7.293c-.391.39-1.024.39-1.414.0-.391-.391-.391-1.024.0-1.414L17.586 5H14zM5 7c-.552.0-1 .448-1 1v11c0 .552.448 1 1 1h11c.552.0 1-.448 1-1v-4.563c0-.552.448-1 1-1s1 .448 1 1V19c0 1.657-1.343 3-3 3H5c-1.657.0-3-1.343-3-3V8c0-1.657 1.343-3 3-3h4.563c.552.0 1 .448 1 1s-.448 1-1 1H5z"/></svg></a> 消费 code，换取用户信息</li><li><a href=https://example.com/org/list rel=external target=_blank>https://example.com/org/list<svg width="16" height="16" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path fill="currentcolor" d="M14 5c-.552.0-1-.448-1-1s.448-1 1-1h6c.552.0 1 .448 1 1v6c0 .552-.448 1-1 1s-1-.448-1-1V6.414l-7.293 7.293c-.391.39-1.024.39-1.414.0-.391-.391-.391-1.024.0-1.414L17.586 5H14zM5 7c-.552.0-1 .448-1 1v11c0 .552.448 1 1 1h11c.552.0 1-.448 1-1v-4.563c0-.552.448-1 1-1s1 .448 1 1V19c0 1.657-1.343 3-3 3H5c-1.657.0-3-1.343-3-3V8c0-1.657 1.343-3 3-3h4.563c.552.0 1 .448 1 1s-.448 1-1 1H5z"/></svg></a> 获取组织列表</li><li><a href=https://example.com/user/list rel=external target=_blank>https://example.com/user/list<svg width="16" height="16" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path fill="currentcolor" d="M14 5c-.552.0-1-.448-1-1s.448-1 1-1h6c.552.0 1 .448 1 1v6c0 .552-.448 1-1 1s-1-.448-1-1V6.414l-7.293 7.293c-.391.39-1.024.39-1.414.0-.391-.391-.391-1.024.0-1.414L17.586 5H14zM5 7c-.552.0-1 .448-1 1v11c0 .552.448 1 1 1h11c.552.0 1-.448 1-1v-4.563c0-.552.448-1 1-1s1 .448 1 1V19c0 1.657-1.343 3-3 3H5c-1.657.0-3-1.343-3-3V8c0-1.657 1.343-3 3-3h4.563c.552.0 1 .448 1 1s-.448 1-1 1H5z"/></svg></a> 获取成员列表</li></ol><h3 id=获取-sso-登录重定向地址>获取 SSO 登录重定向地址 <a href=#%e8%8e%b7%e5%8f%96-sso-%e7%99%bb%e5%bd%95%e9%87%8d%e5%ae%9a%e5%90%91%e5%9c%b0%e5%9d%80 class=anchor aria-hidden=true><i class="material-icons align-middle">link</i></a></h3><p>返回一个重定向登录地址，fastgpt 会自动重定向到该地址。redirect_uri 会自动拼接到该地址的 query中。</p><nav><div class="nav nav-tabs" id=nav-tab role=tablist><a class="nav-link active" id=dbafceTab data-bs-toggle=tab data-bs-target=#dbafce type=button role=tab aria-controls=dbafce aria-selected=true>请求示例</a> </pre></div><h2 id=标准接口文档>标准接口文档 <a href=#%e6%a0%87%e5%87%86%e6%8e%a5%e5%8f%a3%e6%96%87%e6%a1%a3 class=anchor aria-hidden=true><i class="material-icons align-middle">link</i></a></h2><p>以下是 FastGPT-pro 中，SSO 和成员同步的标准接口文档，如果需要对接非标准系统，可以参考该章节进行开发。</p><p><img src=https://cdn.jsdelivr.net/gh/yangchuansheng/fastgpt-imgs@main/imgs/sso18.png alt loading=lazy class=medium-zoom-image></p><p>FastGPT 提供如下标准接口支持：</p><ol><li><a href=https://example.com/login/oauth/getAuthURL rel=external target=_blank>https://example.com/login/oauth/getAuthURL<svg width="16" height="16" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path fill="currentcolor" d="M14 5c-.552.0-1-.448-1-1s.448-1 1-1h6c.552.0 1 .448 1 1v6c0 .552-.448 1-1 1s-1-.448-1-1V6.414l-7.293 7.293c-.391.39-1.024.39-1.414.0-.391-.391-.391-1.024.0-1.414L17.586 5H14zM5 7c-.552.0-1 .448-1 1v11c0 .552.448 1 1 1h11c.552.0 1-.448 1-1v-4.563c0-.552.448-1 1-1s1 .448 1 1V19c0 1.657-1.343 3-3 3H5c-1.657.0-3-1.343-3-3V8c0-1.657 1.343-3 3-3h4.563c.552.0 1 .448 1 1s-.448 1-1 1H5z"/></svg></a> 获取鉴权重定向地址</li><li><a href="https://example.com/login/oauth/getUserInfo?code=xxxxx" rel=external target=_blank>https://example.com/login/oauth/getUserInfo?code=xxxxx<svg width="16" height="16" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path fill="currentcolor" d="M14 5c-.552.0-1-.448-1-1s.448-1 1-1h6c.552.0 1 .448 1 1v6c0 .552-.448 1-1 1s-1-.448-1-1V6.414l-7.293 7.293c-.391.39-1.024.39-1.414.0-.391-.391-.391-1.024.0-1.414L17.586 5H14zM5 7c-.552.0-1 .448-1 1v11c0 .552.448 1 1 1h11c.552.0 1-.448 1-1v-4.563c0-.552.448-1 1-1s1 .448 1 1V19c0 1.657-1.343 3-3 3H5c-1.657.0-3-1.343-3-3V8c0-1.657 1.343-3 3-3h4.563c.552.0 1 .448 1 1s-.448 1-1 1H5z"/></svg></a> 消费 code，换取用户信息</li><li><a href=https://example.com/org/list rel=external target=_blank>https://example.com/org/list<svg width="16" height="16" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path fill="currentcolor" d="M14 5c-.552.0-1-.448-1-1s.448-1 1-1h6c.552.0 1 .448 1 1v6c0 .552-.448 1-1 1s-1-.448-1-1V6.414l-7.293 7.293c-.391.39-1.024.39-1.414.0-.391-.391-.391-1.024.0-1.414L17.586 5H14zM5 7c-.552.0-1 .448-1 1v11c0 .552.448 1 1 1h11c.552.0 1-.448 1-1v-4.563c0-.552.448-1 1-1s1 .448 1 1V19c0 1.657-1.343 3-3 3H5c-1.657.0-3-1.343-3-3V8c0-1.657 1.343-3 3-3h4.563c.552.0 1 .448 1 1s-.448 1-1 1H5z"/></svg></a> 获取组织列表</li><li><a href=https://example.com/user/list rel=external target=_blank>https://example.com/user/list<svg width="16" height="16" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path fill="currentcolor" d="M14 5c-.552.0-1-.448-1-1s.448-1 1-1h6c.552.0 1 .448 1 1v6c0 .552-.448 1-1 1s-1-.448-1-1V6.414l-7.293 7.293c-.391.39-1.024.39-1.414.0-.391-.391-.391-1.024.0-1.414L17.586 5H14zM5 7c-.552.0-1 .448-1 1v11c0 .552.448 1 1 1h11c.552.0 1-.448 1-1v-4.563c0-.552.448-1 1-1s1 .448 1 1V19c0 1.657-1.343 3-3 3H5c-1.657.0-3-1.343-3-3V8c0-1.657 1.343-3 3-3h4.563c.552.0 1 .448 1 1s-.448 1-1 1H5z"/></svg></a> 获取成员列表</li></ol><h3 id=获取-sso-登录重定向地址>获取 SSO 登录重定向地址 <a href=#%e8%8e%b7%e5%8f%96-sso-%e7%99%bb%e5%bd%95%e9%87%8d%e5%ae%9a%e5%90%91%e5%9c%b0%e5%9d%80 class=anchor aria-hidden=true><i class="material-icons align-middle">link</i></a></h3><p>返回一个重定向登录地址，fastgpt 会自动重定向到该地址。redirect_uri 会自动拼接到该地址的 query中。</p><nav><div class="nav nav-tabs" id=nav-tab role=tablist><a class="nav-link active" id=beacfdTab data-bs-toggle=tab data-bs-target=#beacfd type=button role=tab aria-controls=beacfd aria-selected=true>请求示例</a>
<a class=nav-link id=dbafceTab data-bs-toggle=tab data-bs-target=#dbafce type=button role=tab aria-controls=dbafce aria-selected=true>响应示例</a></div></nav><div class=tab-content id=nav-tab-content><div class="tab-pane fade show active" id=dbafce role=tabpanel aria-labelledby=nav-1><div class=prism-codeblock><pre id=3970eeb class=language-bash> <a class=nav-link id=bdcefaTab data-bs-toggle=tab data-bs-target=#bdcefa type=button role=tab aria-controls=bdcefa aria-selected=true>响应示例</a></div></nav><div class=tab-content id=nav-tab-content><div class="tab-pane fade show active" id=beacfd role=tabpanel aria-labelledby=nav-1><div class=prism-codeblock><pre id=3970eeb class=language-bash>
<code>curl -X GET &#34;https://redict.example/login/oauth/getAuthURL?redirect_uri=xxx&amp;state=xxxx&#34; \ <code>curl -X GET &#34;https://redict.example/login/oauth/getAuthURL?redirect_uri=xxx&amp;state=xxxx&#34; \
-H &#34;Authorization: Bearer your_token_here&#34; \ -H &#34;Authorization: Bearer your_token_here&#34; \
-H &#34;Content-Type: application/json&#34;</code> -H &#34;Content-Type: application/json&#34;</code>
</pre></div></div><div class="tab-pane fade" id=dbafce role=tabpanel aria-labelledby=nav-1><p>成功：</p><div class=prism-codeblock><pre id=8296736 class=language-JSON> </pre></div></div><div class="tab-pane fade" id=bdcefa role=tabpanel aria-labelledby=nav-1><p>成功：</p><div class=prism-codeblock><pre id=8296736 class=language-JSON>
<code>{ <code>{
&#34;success&#34;: true, &#34;success&#34;: true,
&#34;message&#34;: &#34;&#34;, &#34;message&#34;: &#34;&#34;,
@ -177,12 +177,12 @@ Table of Contents</button><nav id=toc-mobile><ul class=dropdown-menu><li><ul><li
&#34;message&#34;: &#34;错误信息&#34;, &#34;message&#34;: &#34;错误信息&#34;,
&#34;authURL&#34;: &#34;&#34; &#34;authURL&#34;: &#34;&#34;
}</code> }</code>
</pre></div></div></div><h3 id=sso-获取用户信息>SSO 获取用户信息 <a href=#sso-%e8%8e%b7%e5%8f%96%e7%94%a8%e6%88%b7%e4%bf%a1%e6%81%af class=anchor aria-hidden=true><i class="material-icons align-middle">link</i></a></h3><p>该接口接受一个 code 参数作为鉴权，消费 code 返回用户信息。</p><nav><div class="nav nav-tabs" id=nav-tab role=tablist><a class="nav-link active" id=badcfeTab data-bs-toggle=tab data-bs-target=#badcfe type=button role=tab aria-controls=badcfe aria-selected=true>请求示例</a> </pre></div></div></div><h3 id=sso-获取用户信息>SSO 获取用户信息 <a href=#sso-%e8%8e%b7%e5%8f%96%e7%94%a8%e6%88%b7%e4%bf%a1%e6%81%af class=anchor aria-hidden=true><i class="material-icons align-middle">link</i></a></h3><p>该接口接受一个 code 参数作为鉴权，消费 code 返回用户信息。</p><nav><div class="nav nav-tabs" id=nav-tab role=tablist><a class="nav-link active" id=eabcdfTab data-bs-toggle=tab data-bs-target=#eabcdf type=button role=tab aria-controls=eabcdf aria-selected=true>请求示例</a>
<a class=nav-link id=edbcfaTab data-bs-toggle=tab data-bs-target=#edbcfa type=button role=tab aria-controls=edbcfa aria-selected=true>响应示例</a></div></nav><div class=tab-content id=nav-tab-content><div class="tab-pane fade show active" id=badcfe role=tabpanel aria-labelledby=nav-1><div class=prism-codeblock><pre id=532f1a3 class=language-bash> <a class=nav-link id=fdacebTab data-bs-toggle=tab data-bs-target=#fdaceb type=button role=tab aria-controls=fdaceb aria-selected=true>响应示例</a></div></nav><div class=tab-content id=nav-tab-content><div class="tab-pane fade show active" id=eabcdf role=tabpanel aria-labelledby=nav-1><div class=prism-codeblock><pre id=532f1a3 class=language-bash>
<code>curl -X GET &#34;https://oauth.example/login/oauth/getUserInfo?code=xxxxxx&#34; \ <code>curl -X GET &#34;https://oauth.example/login/oauth/getUserInfo?code=xxxxxx&#34; \
-H &#34;Authorization: Bearer your_token_here&#34; \ -H &#34;Authorization: Bearer your_token_here&#34; \
-H &#34;Content-Type: application/json&#34;</code> -H &#34;Content-Type: application/json&#34;</code>
</pre></div></div><div class="tab-pane fade" id=edbcfa role=tabpanel aria-labelledby=nav-1><p>成功：</p><div class=prism-codeblock><pre id=71afe34 class=language-JSON> </pre></div></div><div class="tab-pane fade" id=fdaceb role=tabpanel aria-labelledby=nav-1><p>成功：</p><div class=prism-codeblock><pre id=71afe34 class=language-JSON>
<code>{ <code>{
&#34;success&#34;: true, &#34;success&#34;: true,
&#34;message&#34;: &#34;&#34;, &#34;message&#34;: &#34;&#34;,
@ -199,12 +199,12 @@ Table of Contents</button><nav id=toc-mobile><ul class=dropdown-menu><li><ul><li
&#34;avatar&#34;: &#34;&#34;, &#34;avatar&#34;: &#34;&#34;,
&#34;contact&#34;: &#34;&#34; &#34;contact&#34;: &#34;&#34;
}</code> }</code>
</pre></div></div></div><h3 id=获取组织>获取组织 <a href=#%e8%8e%b7%e5%8f%96%e7%bb%84%e7%bb%87 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=fdbecaTab data-bs-toggle=tab data-bs-target=#fdbeca type=button role=tab aria-controls=fdbeca aria-selected=true>请求示例</a> </pre></div></div></div><h3 id=获取组织>获取组织 <a href=#%e8%8e%b7%e5%8f%96%e7%bb%84%e7%bb%87 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=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=cdfbaeTab data-bs-toggle=tab data-bs-target=#cdfbae type=button role=tab aria-controls=cdfbae aria-selected=true>响应示例</a></div></nav><div class=tab-content id=nav-tab-content><div class="tab-pane fade show active" id=fdbeca role=tabpanel aria-labelledby=nav-1><div class=prism-codeblock><pre id=d289d9a class=language-bash> <a class=nav-link id=aefbdcTab data-bs-toggle=tab data-bs-target=#aefbdc type=button role=tab aria-controls=aefbdc aria-selected=true>响应示例</a></div></nav><div class=tab-content id=nav-tab-content><div class="tab-pane fade show active" id=ecdbfa role=tabpanel aria-labelledby=nav-1><div class=prism-codeblock><pre id=d289d9a class=language-bash>
<code>curl -X GET &#34;https://example.com/org/list&#34; \ <code>curl -X GET &#34;https://example.com/org/list&#34; \
-H &#34;Authorization: Bearer your_token_here&#34; \ -H &#34;Authorization: Bearer your_token_here&#34; \
-H &#34;Content-Type: application/json&#34;</code> -H &#34;Content-Type: application/json&#34;</code>
</pre></div></div><div class="tab-pane fade" id=cdfbae role=tabpanel aria-labelledby=nav-1><p>⚠️注意：只能存在一个根部门。如果你的系统中存在多个根部门，需要先进行处理，加一个虚拟的根部门。返回值类型：</p><div class=prism-codeblock><pre id=5634349 class=language-ts> </pre></div></div><div class="tab-pane fade" id=aefbdc role=tabpanel aria-labelledby=nav-1><p>⚠️注意：只能存在一个根部门。如果你的系统中存在多个根部门，需要先进行处理，加一个虚拟的根部门。返回值类型：</p><div class=prism-codeblock><pre id=5634349 class=language-ts>
<code>type OrgListResponseType = { <code>type OrgListResponseType = {
message?: string; // 报错信息 message?: string; // 报错信息
success: boolean; success: boolean;
@ -231,12 +231,12 @@ Table of Contents</button><nav id=toc-mobile><ul class=dropdown-menu><li><ul><li
} }
] ]
}</code> }</code>
</pre></div></div></div><h3 id=获取成员>获取成员 <a href=#%e8%8e%b7%e5%8f%96%e6%88%90%e5%91%98 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=dbfcaeTab data-bs-toggle=tab data-bs-target=#dbfcae type=button role=tab aria-controls=dbfcae aria-selected=true>请求示例</a> </pre></div></div></div><h3 id=获取成员>获取成员 <a href=#%e8%8e%b7%e5%8f%96%e6%88%90%e5%91%98 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=bdafecTab data-bs-toggle=tab data-bs-target=#bdafec type=button role=tab aria-controls=bdafec aria-selected=true>请求示例</a>
<a class=nav-link id=bcaedfTab data-bs-toggle=tab data-bs-target=#bcaedf type=button role=tab aria-controls=bcaedf aria-selected=true>响应示例</a></div></nav><div class=tab-content id=nav-tab-content><div class="tab-pane fade show active" id=dbfcae role=tabpanel aria-labelledby=nav-1><div class=prism-codeblock><pre id=bc9e9ec class=language-bash> <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></div></nav><div class=tab-content id=nav-tab-content><div class="tab-pane fade show active" id=bdafec role=tabpanel aria-labelledby=nav-1><div class=prism-codeblock><pre id=bc9e9ec class=language-bash>
<code>curl -X GET &#34;https://example.com/user/list&#34; \ <code>curl -X GET &#34;https://example.com/user/list&#34; \
-H &#34;Authorization: Bearer your_token_here&#34; \ -H &#34;Authorization: Bearer your_token_here&#34; \
-H &#34;Content-Type: application/json&#34;</code> -H &#34;Content-Type: application/json&#34;</code>
</pre></div></div><div class="tab-pane fade" id=bcaedf role=tabpanel aria-labelledby=nav-1><p>返回值类型：</p><div class=prism-codeblock><pre id=3f6bc41 class=language-typescript> </pre></div></div><div class="tab-pane fade" id=bdeafc role=tabpanel aria-labelledby=nav-1><p>返回值类型：</p><div class=prism-codeblock><pre id=3f6bc41 class=language-typescript>
<code>type UserListResponseListType = { <code>type UserListResponseListType = {
message?: string; // 报错信息 message?: string; // 报错信息
success: boolean; success: boolean;

16
docs/guide/dashboard/workflow/http/index.html
View File

File diff suppressed because one or more lines are too long

20
docs/guide/knowledge_base/api_dataset/index.html
View File

@ -50,8 +50,8 @@ type FileListItem = {
updateTime: Date; updateTime: Date;
createTime: Date; createTime: Date;
}</code> }</code>
</pre></div><h3 id=1-获取文件树>1. 获取文件树 <a href=#1-%e8%8e%b7%e5%8f%96%e6%96%87%e4%bb%b6%e6%a0%91 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=ebafdcTab data-bs-toggle=tab data-bs-target=#ebafdc type=button role=tab aria-controls=ebafdc aria-selected=true>请求示例</a> </pre></div><h3 id=1-获取文件树>1. 获取文件树 <a href=#1-%e8%8e%b7%e5%8f%96%e6%96%87%e4%bb%b6%e6%a0%91 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=ebdcfaTab data-bs-toggle=tab data-bs-target=#ebdcfa type=button role=tab aria-controls=ebdcfa 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></div></nav><div class=tab-content id=nav-tab-content><div class="tab-pane fade show active" id=ebafdc 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>searchKey - 检索词，可选</li></ul></div></div><div class=prism-codeblock><pre id=04b20e5 class=language-bash> <a class=nav-link id=dfcbaeTab data-bs-toggle=tab data-bs-target=#dfcbae type=button role=tab aria-controls=dfcbae aria-selected=true>响应示例</a></div></nav><div class=tab-content id=nav-tab-content><div class="tab-pane fade show active" id=ebdcfa 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>searchKey - 检索词，可选</li></ul></div></div><div class=prism-codeblock><pre id=04b20e5 class=language-bash>
<code>curl --location --request POST &#39;{{baseURL}}/v1/file/list&#39; \ <code>curl --location --request POST &#39;{{baseURL}}/v1/file/list&#39; \
--header &#39;Authorization: Bearer {{authorization}}&#39; \ --header &#39;Authorization: Bearer {{authorization}}&#39; \
--header &#39;Content-Type: application/json&#39; \ --header &#39;Content-Type: application/json&#39; \
@ -59,7 +59,7 @@ type FileListItem = {
&#34;parentId&#34;: null, &#34;parentId&#34;: null,
&#34;searchKey&#34;: &#34;&#34; &#34;searchKey&#34;: &#34;&#34;
}&#39;</code> }&#39;</code>
</pre></div></div><div class="tab-pane fade" id=fdbaec role=tabpanel aria-labelledby=nav-1><div class=prism-codeblock><pre id=ee58785 class=language-json> </pre></div></div><div class="tab-pane fade" id=dfcbae role=tabpanel aria-labelledby=nav-1><div class=prism-codeblock><pre id=ee58785 class=language-json>
<code>{ <code>{
&#34;code&#34;: 200, &#34;code&#34;: 200,
&#34;success&#34;: true, &#34;success&#34;: true,
@ -75,12 +75,12 @@ type FileListItem = {
} }
] ]
}</code> }</code>
</pre></div></div></div><h3 id=2-获取单个文件内容文本内容或访问链接>2. 获取单个文件内容（文本内容或访问链接） <a href=#2-%e8%8e%b7%e5%8f%96%e5%8d%95%e4%b8%aa%e6%96%87%e4%bb%b6%e5%86%85%e5%ae%b9%e6%96%87%e6%9c%ac%e5%86%85%e5%ae%b9%e6%88%96%e8%ae%bf%e9%97%ae%e9%93%be%e6%8e%a5 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=fdebcaTab data-bs-toggle=tab data-bs-target=#fdebca type=button role=tab aria-controls=fdebca aria-selected=true>请求示例</a> </pre></div></div></div><h3 id=2-获取单个文件内容文本内容或访问链接>2. 获取单个文件内容（文本内容或访问链接） <a href=#2-%e8%8e%b7%e5%8f%96%e5%8d%95%e4%b8%aa%e6%96%87%e4%bb%b6%e5%86%85%e5%ae%b9%e6%96%87%e6%9c%ac%e5%86%85%e5%ae%b9%e6%88%96%e8%ae%bf%e9%97%ae%e9%93%be%e6%8e%a5 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=ebdcafTab data-bs-toggle=tab data-bs-target=#ebdcaf type=button role=tab aria-controls=ebdcaf aria-selected=true>请求示例</a>
<a class=nav-link id=abcefdTab data-bs-toggle=tab data-bs-target=#abcefd type=button role=tab aria-controls=abcefd aria-selected=true>响应示例</a> <a class=nav-link id=aedcfbTab data-bs-toggle=tab data-bs-target=#aedcfb type=button role=tab aria-controls=aedcfb aria-selected=true>响应示例</a>
<a class=nav-link id=Tab data-bs-toggle=tab data-bs-target=# type=button role=tab aria-controls aria-selected=true></a></div></nav><div class=tab-content id=nav-tab-content><div class="tab-pane fade show active" id=fdebca role=tabpanel aria-labelledby=nav-1><div class=prism-codeblock><pre id=1de88d3 class=language-bash> <a class=nav-link id=Tab data-bs-toggle=tab data-bs-target=# type=button role=tab aria-controls aria-selected=true></a></div></nav><div class=tab-content id=nav-tab-content><div class="tab-pane fade show active" id=ebdcaf role=tabpanel aria-labelledby=nav-1><div class=prism-codeblock><pre id=1de88d3 class=language-bash>
<code>curl --location --request GET &#39;{{baseURL}}/v1/file/content?id=xx&#39; \ <code>curl --location --request GET &#39;{{baseURL}}/v1/file/content?id=xx&#39; \
--header &#39;Authorization: Bearer {{authorization}}&#39;</code> --header &#39;Authorization: Bearer {{authorization}}&#39;</code>
</pre></div></div><div class="tab-pane fade" id=abcefd role=tabpanel aria-labelledby=nav-1><div class=prism-codeblock><pre id=bcbc70a class=language-json> </pre></div></div><div class="tab-pane fade" id=aedcfb role=tabpanel aria-labelledby=nav-1><div class=prism-codeblock><pre id=bcbc70a class=language-json>
<code>{ <code>{
&#34;code&#34;: 200, &#34;code&#34;: 200,
&#34;success&#34;: true, &#34;success&#34;: true,
@ -91,11 +91,11 @@ type FileListItem = {
&#34;previewUrl&#34;: &#34;xxxx&#34; &#34;previewUrl&#34;: &#34;xxxx&#34;
} }
}</code> }</code>
</pre></div><div class="alert alert-success d-flex" role=alert><div class="flex-shrink-1 alert-icon"></div><div class=w-100><ul><li>title - 文件标题。</li><li>content - 文件内容，直接拿来用。</li><li>previewUrl - 文件链接，系统会请求该地址获取文件内容。</li></ul><p><code>content</code>和<code>previewUrl</code>二选一返回，如果同时返回则 <code>content</code> 优先级更高，返回 <code>previewUrl</code>时，则会访问该链接进行文档内容读取。</p></div></div></div></div><h3 id=3-获取文件阅读链接用于查看原文>3. 获取文件阅读链接（用于查看原文） <a href=#3-%e8%8e%b7%e5%8f%96%e6%96%87%e4%bb%b6%e9%98%85%e8%af%bb%e9%93%be%e6%8e%a5%e7%94%a8%e4%ba%8e%e6%9f%a5%e7%9c%8b%e5%8e%9f%e6%96%87 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=beadfcTab data-bs-toggle=tab data-bs-target=#beadfc type=button role=tab aria-controls=beadfc aria-selected=true>请求示例</a> </pre></div><div class="alert alert-success d-flex" role=alert><div class="flex-shrink-1 alert-icon"></div><div class=w-100><ul><li>title - 文件标题。</li><li>content - 文件内容，直接拿来用。</li><li>previewUrl - 文件链接，系统会请求该地址获取文件内容。</li></ul><p><code>content</code>和<code>previewUrl</code>二选一返回，如果同时返回则 <code>content</code> 优先级更高，返回 <code>previewUrl</code>时，则会访问该链接进行文档内容读取。</p></div></div></div></div><h3 id=3-获取文件阅读链接用于查看原文>3. 获取文件阅读链接（用于查看原文） <a href=#3-%e8%8e%b7%e5%8f%96%e6%96%87%e4%bb%b6%e9%98%85%e8%af%bb%e9%93%be%e6%8e%a5%e7%94%a8%e4%ba%8e%e6%9f%a5%e7%9c%8b%e5%8e%9f%e6%96%87 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=acfedbTab data-bs-toggle=tab data-bs-target=#acfedb type=button role=tab aria-controls=acfedb aria-selected=true>请求示例</a>
<a class=nav-link id=aedfbcTab data-bs-toggle=tab data-bs-target=#aedfbc type=button role=tab aria-controls=aedfbc aria-selected=true>响应示例</a></div></nav><div class=tab-content id=nav-tab-content><div class="tab-pane fade show active" id=beadfc role=tabpanel aria-labelledby=nav-1><p>id 为文件的 id。</p><div class=prism-codeblock><pre id=3291e95 class=language-bash> <a class=nav-link id=bcfaedTab data-bs-toggle=tab data-bs-target=#bcfaed type=button role=tab aria-controls=bcfaed aria-selected=true>响应示例</a></div></nav><div class=tab-content id=nav-tab-content><div class="tab-pane fade show active" id=acfedb role=tabpanel aria-labelledby=nav-1><p>id 为文件的 id。</p><div class=prism-codeblock><pre id=3291e95 class=language-bash>
<code>curl --location --request GET &#39;{{baseURL}}/v1/file/read?id=xx&#39; \ <code>curl --location --request GET &#39;{{baseURL}}/v1/file/read?id=xx&#39; \
--header &#39;Authorization: Bearer {{authorization}}&#39;</code> --header &#39;Authorization: Bearer {{authorization}}&#39;</code>
</pre></div></div><div class="tab-pane fade" id=aedfbc role=tabpanel aria-labelledby=nav-1><div class=prism-codeblock><pre id=9102b7d class=language-json> </pre></div></div><div class="tab-pane fade" id=bcfaed role=tabpanel aria-labelledby=nav-1><div class=prism-codeblock><pre id=9102b7d class=language-json>
<code>{ <code>{
&#34;code&#34;: 200, &#34;code&#34;: 200,
&#34;success&#34;: true, &#34;success&#34;: true,