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

deploy: d44c338059

Browse Source
This commit is contained in:
c121914yu
2025-05-20 05:42:35 +00:00
parent b5daa3df70
commit 7dacb8780c
11 changed files with 228 additions and 228 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -50,8 +50,8 @@ type FileListItem = {
updateTime: Date;
createTime: Date;
}</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=faebcdTab data-bs-toggle=tab data-bs-target=#faebcd type=button role=tab aria-controls=faebcd aria-selected=true>请求示例</a>
<a class=nav-link id=fecabdTab data-bs-toggle=tab data-bs-target=#fecabd type=button role=tab aria-controls=fecabd aria-selected=true>响应示例</a></div></nav><div class=tab-content id=nav-tab-content><div class="tab-pane fade show active" id=faebcd 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 | undefined。</li><li>searchKey - 检索词，可选</li></ul></div></div><div class=prism-codeblock><pre id=25aa990 class=language-bash>
</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=cbdfeaTab data-bs-toggle=tab data-bs-target=#cbdfea type=button role=tab aria-controls=cbdfea aria-selected=true>请求示例</a>
<a class=nav-link id=feadbcTab data-bs-toggle=tab data-bs-target=#feadbc type=button role=tab aria-controls=feadbc aria-selected=true>响应示例</a></div></nav><div class=tab-content id=nav-tab-content><div class="tab-pane fade show active" id=cbdfea 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 | undefined。</li><li>searchKey - 检索词，可选</li></ul></div></div><div class=prism-codeblock><pre id=25aa990 class=language-bash>
<code>curl --location --request POST &#39;{{baseURL}}/v1/file/list&#39; \
--header &#39;Authorization: Bearer {{authorization}}&#39; \
--header &#39;Content-Type: application/json&#39; \
@@ -59,7 +59,7 @@ type FileListItem = {
&#34;parentId&#34;: &#34;&#34;,
&#34;searchKey&#34;: &#34;&#34;
}&#39;</code>
</pre></div></div><div class="tab-pane fade" id=fecabd 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=feadbc role=tabpanel aria-labelledby=nav-1><div class=prism-codeblock><pre id=ee58785 class=language-json>
<code>{
&#34;code&#34;: 200,
&#34;success&#34;: true,
@@ -75,12 +75,12 @@ type FileListItem = {
}
]
}</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=dafcbeTab data-bs-toggle=tab data-bs-target=#dafcbe type=button role=tab aria-controls=dafcbe aria-selected=true>请求示例</a>
<a class=nav-link id=cebdafTab data-bs-toggle=tab data-bs-target=#cebdaf type=button role=tab aria-controls=cebdaf 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=dafcbe role=tabpanel aria-labelledby=nav-1><div class=prism-codeblock><pre id=1de88d3 class=language-bash>
</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=dbcfaeTab data-bs-toggle=tab data-bs-target=#dbcfae type=button role=tab aria-controls=dbcfae aria-selected=true>请求示例</a>
<a class=nav-link id=efbadcTab data-bs-toggle=tab data-bs-target=#efbadc type=button role=tab aria-controls=efbadc 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=dbcfae 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; \
--header &#39;Authorization: Bearer {{authorization}}&#39;</code>
</pre></div></div><div class="tab-pane fade" id=cebdaf 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=efbadc role=tabpanel aria-labelledby=nav-1><div class=prism-codeblock><pre id=bcbc70a class=language-json>
<code>{
&#34;code&#34;: 200,
&#34;success&#34;: true,
@@ -91,11 +91,11 @@ type FileListItem = {
&#34;previewUrl&#34;: &#34;xxxx&#34;
}
}</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=becadfTab data-bs-toggle=tab data-bs-target=#becadf type=button role=tab aria-controls=becadf 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=becadf role=tabpanel aria-labelledby=nav-1><p>id 为文件的 id。</p><div class=prism-codeblock><pre id=3291e95 class=language-bash>
</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=cbdaefTab data-bs-toggle=tab data-bs-target=#cbdaef type=button role=tab aria-controls=cbdaef aria-selected=true>请求示例</a>
<a class=nav-link id=cedfbaTab data-bs-toggle=tab data-bs-target=#cedfba type=button role=tab aria-controls=cedfba aria-selected=true>响应示例</a></div></nav><div class=tab-content id=nav-tab-content><div class="tab-pane fade show active" id=cbdaef 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; \
--header &#39;Authorization: Bearer {{authorization}}&#39;</code>
</pre></div></div><div class="tab-pane fade" id=fbadce 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=cedfba role=tabpanel aria-labelledby=nav-1><div class=prism-codeblock><pre id=9102b7d class=language-json>
<code>{
&#34;code&#34;: 200,
&#34;success&#34;: true,
@@ -104,11 +104,11 @@ type FileListItem = {
&#34;url&#34;: &#34;xxxx&#34;
}
}</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>url - 文件访问链接，拿到后会自动打开。</li></ul></div></div></div></div><h3 id=4-获取文件详细信息用于获取文件信息>4. 获取文件详细信息（用于获取文件信息） <a href=#4-%e8%8e%b7%e5%8f%96%e6%96%87%e4%bb%b6%e8%af%a6%e7%bb%86%e4%bf%a1%e6%81%af%e7%94%a8%e4%ba%8e%e8%8e%b7%e5%8f%96%e6%96%87%e4%bb%b6%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=fedacbTab data-bs-toggle=tab data-bs-target=#fedacb type=button role=tab aria-controls=fedacb aria-selected=true>请求示例</a>
<a class=nav-link id=abcedfTab data-bs-toggle=tab data-bs-target=#abcedf type=button role=tab aria-controls=abcedf aria-selected=true>响应示例</a></div></nav><div class=tab-content id=nav-tab-content><div class="tab-pane fade show active" id=fedacb role=tabpanel aria-labelledby=nav-1><p>id 为文件的 id。</p><div class=prism-codeblock><pre id=3570318 class=language-bash>
</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>url - 文件访问链接，拿到后会自动打开。</li></ul></div></div></div></div><h3 id=4-获取文件详细信息用于获取文件信息>4. 获取文件详细信息（用于获取文件信息） <a href=#4-%e8%8e%b7%e5%8f%96%e6%96%87%e4%bb%b6%e8%af%a6%e7%bb%86%e4%bf%a1%e6%81%af%e7%94%a8%e4%ba%8e%e8%8e%b7%e5%8f%96%e6%96%87%e4%bb%b6%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=bcedfaTab data-bs-toggle=tab data-bs-target=#bcedfa type=button role=tab aria-controls=bcedfa aria-selected=true>请求示例</a>
<a class=nav-link id=dfebcaTab data-bs-toggle=tab data-bs-target=#dfebca type=button role=tab aria-controls=dfebca aria-selected=true>响应示例</a></div></nav><div class=tab-content id=nav-tab-content><div class="tab-pane fade show active" id=bcedfa role=tabpanel aria-labelledby=nav-1><p>id 为文件的 id。</p><div class=prism-codeblock><pre id=3570318 class=language-bash>
<code>curl --location --request GET &#39;{{baseURL}}/v1/file/detail?id=xx&#39; \
--header &#39;Authorization: Bearer {{authorization}}&#39;</code>
</pre></div></div><div class="tab-pane fade" id=abcedf role=tabpanel aria-labelledby=nav-1><div class=prism-codeblock><pre id=fa15e80 class=language-json>
</pre></div></div><div class="tab-pane fade" id=dfebca role=tabpanel aria-labelledby=nav-1><div class=prism-codeblock><pre id=fa15e80 class=language-json>
<code>{
&#34;code&#34;: 200,
&#34;success&#34;: true,