Skip to content

Commit 466c08f

Browse files
xuwei-fit2cloudxuwei-fit2cloud
committed
Deployed fb80108 to v1 with MkDocs 1.6.1 and mike 1.1.2
1 parent 2baec35 commit 466c08f

File tree

9 files changed

+226
-81
lines changed

9 files changed

+226
-81
lines changed

‎v1/faq/datasource/index.html‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1755,6 +1755,17 @@
17551755
</span>
17561756
</a>
17571757

1758+
</li>
1759+
1760+
<li class="md-nav__item">
1761+
<a href="#2" class="md-nav__link">
1762+
<span class="md-ellipsis">
1763+
1764+
2 数据源连接无效？
1765+
1766+
</span>
1767+
</a>
1768+
17581769
</li>
17591770

17601771
</ul>
@@ -2085,6 +2096,17 @@
20852096
</span>
20862097
</a>
20872098

2099+
</li>
2100+
2101+
<li class="md-nav__item">
2102+
<a href="#2" class="md-nav__link">
2103+
<span class="md-ellipsis">
2104+
2105+
2 数据源连接无效？
2106+
2107+
</span>
2108+
</a>
2109+
20882110
</li>
20892111

20902112
</ul>
@@ -2118,6 +2140,15 @@ <h2 id="1">1 达梦数据源无法连接？<a class="headerlink" href="#1" title
21182140
<p>docker-compose.yml文件修改示例：</p>
21192141
<p><img alt="示例" src="../../img/faq/dameng_issue.jpg" /></p>
21202142
</div>
2143+
<h2 id="2">2 数据源连接无效？<a class="headerlink" href="#2" title="Permanent link">&para;</a></h2>
2144+
<div class="admonition abstract">
2145+
<p>数据源本身服务正常，但添加到 SQLBot 中时，提示数据源连接无效。可能的原因：</p>
2146+
<ul>
2147+
<li>SQLBot 默认以 docker 方式运行，在 SQLBot 容器中访问 localhost，或者 127.0.0.1 等本地地址时，均指向 SQLBot 容器自身，而不是 SQLBot 容器外的其他服务。此时可以将数据源的 IP 换成服务器的内网或公网 IP 即可，如果是本机服务，也可以输入 host.docker.internal</li>
2148+
<li>docker network 配置有问题，导致容器内无法访问到容器外的地址，可以试着将 docker network mode 调整为 host，然后重启服务</li>
2149+
<li>数据源服务器的防火墙是否开放了对应的端口，公有云的服务器还需要检查服务器对应的安全组规则是否开放了对应端口</li>
2150+
</ul>
2151+
</div>
21212152

21222153

21232154

‎v1/faq/smart_question_description/index.html‎

Lines changed: 99 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1805,6 +1805,39 @@
18051805
</span>
18061806
</a>
18071807

1808+
</li>
1809+
1810+
<li class="md-nav__item">
1811+
<a href="#4-sqlbot-token" class="md-nav__link">
1812+
<span class="md-ellipsis">
1813+
1814+
4 SQLBot 在哪些方面会影响到对 token 的消耗？
1815+
1816+
</span>
1817+
</a>
1818+
1819+
</li>
1820+
1821+
<li class="md-nav__item">
1822+
<a href="#5-sqlbot" class="md-nav__link">
1823+
<span class="md-ellipsis">
1824+
1825+
5 如何提升 SQLBot 问数的准确率？
1826+
1827+
</span>
1828+
</a>
1829+
1830+
</li>
1831+
1832+
<li class="md-nav__item">
1833+
<a href="#6-sqlbot" class="md-nav__link">
1834+
<span class="md-ellipsis">
1835+
1836+
6 问数过程中大模型有响应，但 SQLBot 显示解析响应结果出错
1837+
1838+
</span>
1839+
</a>
1840+
18081841
</li>
18091842

18101843
</ul>
@@ -2129,6 +2162,39 @@
21292162
</span>
21302163
</a>
21312164

2165+
</li>
2166+
2167+
<li class="md-nav__item">
2168+
<a href="#4-sqlbot-token" class="md-nav__link">
2169+
<span class="md-ellipsis">
2170+
2171+
4 SQLBot 在哪些方面会影响到对 token 的消耗？
2172+
2173+
</span>
2174+
</a>
2175+
2176+
</li>
2177+
2178+
<li class="md-nav__item">
2179+
<a href="#5-sqlbot" class="md-nav__link">
2180+
<span class="md-ellipsis">
2181+
2182+
5 如何提升 SQLBot 问数的准确率？
2183+
2184+
</span>
2185+
</a>
2186+
2187+
</li>
2188+
2189+
<li class="md-nav__item">
2190+
<a href="#6-sqlbot" class="md-nav__link">
2191+
<span class="md-ellipsis">
2192+
2193+
6 问数过程中大模型有响应，但 SQLBot 显示解析响应结果出错
2194+
2195+
</span>
2196+
</a>
2197+
21322198
</li>
21332199

21342200
</ul>
@@ -2160,14 +2226,45 @@ <h2 id="2">2 术语怎么使用？<a class="headerlink" href="#2" title="Permane
21602226
<div class="admonition abstract">
21612227
<p>当用户发起问数请求时，会根据发送的问题匹配术语，被匹配到的术语，会将「术语描述」和「用户问题」一起发送给大语言模型，辅助生成正确的 SQL 查询语句。</p>
21622228
<p>术语示例如下图所示：</p>
2163-
</div>
21642229
<p><img alt="professional..png" src="../../img/faq/professional..png" /></p>
2230+
</div>
21652231
<h2 id="3-sql">3 SQL 示例怎么使用？<a class="headerlink" href="#3-sql" title="Permanent link">&para;</a></h2>
21662232
<div class="admonition abstract">
21672233
<p>当用户发起问数请求时，将发送的问题与 SQL 示例库中的问题进行匹配，被匹配到的 SQL 示例，会将问题的「 示例 SQL」和「用户问题」一起发送给大语言模型，辅助生成正确的 SQL 查询语句。</p>
21682234
<p>SQL 示例如下图所示：</p>
2169-
</div>
21702235
<p><img alt="data_training.png" src="../../img/faq/data_training.png" /></p>
2236+
</div>
2237+
<h2 id="4-sqlbot-token">4 SQLBot 在哪些方面会影响到对 token 的消耗？<a class="headerlink" href="#4-sqlbot-token" title="Permanent link">&para;</a></h2>
2238+
<div class="admonition abstract">
2239+
<p>问数的时候对 token 的消耗主要有几个地方：</p>
2240+
<ul>
2241+
<li>SQLBot 自身的提示词模板</li>
2242+
<li>匹配到和问数相关的数据表结构，包括描述</li>
2243+
<li>匹配到和问数相关的术语</li>
2244+
<li>匹配到和问数相关的 SQL示例</li>
2245+
<li>匹配到和问数相关的自定义提示词</li>
2246+
</ul>
2247+
<p>如果上面这几个地方内容多的话，对 token 的消耗会比较大，另外，在问数过程中的上下文也会有一定的 token 消耗。</p>
2248+
</div>
2249+
<h2 id="5-sqlbot">5 如何提升 SQLBot 问数的准确率？<a class="headerlink" href="#5-sqlbot" title="Permanent link">&para;</a></h2>
2250+
<div class="admonition abstract">
2251+
<p>可以通过以下几个方面的设置来提升 SQLBot 的问数准确率：</p>
2252+
<ul>
2253+
<li>调整问题的问法，表达意图更清晰一些</li>
2254+
<li>在 SQLBot 中为数据源、数据表、数据字段添加和常见问题相关的描述信息</li>
2255+
<li>在术语配置里将一些数据源中的业务概念添加为术语，让大模型更好的理解问题</li>
2256+
<li>在 SQL 示例库中添加一些数据源常见的查询示例，让大模型可以学习如何正确生成 SQL</li>
2257+
<li>在自定义提示词（商业版）中针对数据源添加一些和常见问题场景相关的约束</li>
2258+
<li>若存在多表关联查询的场景，可以在数据源的表关系管理中，给关联表设置字段的关联关系</li>
2259+
<li>试试其他的大模型，换个强一些的大模型，虽然简单粗暴，但效果明显</li>
2260+
</ul>
2261+
</div>
2262+
<h2 id="6-sqlbot">6 问数过程中大模型有响应，但 SQLBot 显示解析响应结果出错<a class="headerlink" href="#6-sqlbot" title="Permanent link">&para;</a></h2>
2263+
<div class="admonition abstract">
2264+
<p>SQLBot 对大模型返回的问数结果的结构是有要求的，SQLBot 在提示词模板中对该格式有明确定义。在使用过程中，有些大模型由于理解能力问题，并未按要求返回相应格式的数据，会导致 SQLBot 无法解析返回结果，出现类似下图的错误：
2265+
<img alt="faq_parse_answer.png" src="../../img/faq/faq_parse_answer.png" /></p>
2266+
<p>此时建议更换其他模型试试。</p>
2267+
</div>
21712268

21722269

21732270

‎v1/img/faq/faq_parse_answer.png‎

228 KB
Loading

‎v1/installation/online_installtion/index.html‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2222,6 +2222,21 @@ <h2 id="3">3 安装部署<a class="headerlink" href="#3" title="Permanent link">
22222222
--privileged=true \
22232223
dataease/sqlbot
22242224
</code></pre></div>
2225+
<p>如果需要使用 MCP 功能的话，在启动命令中加上 SERVER_IMAGE_HOST 参数，注意将 IP 和端口替换成自己的实际 IP 和端口：
2226+
<div class="highlight"><pre><span></span><code>docker run -d \
2227+
--name sqlbot \
2228+
--restart unless-stopped \
2229+
-p 8000:8000 \
2230+
-p 8001:8001 \
2231+
-e SERVER_IMAGE_HOST=http://47.92.75.231:8001/images/ \
2232+
-v data/sqlbot/excel:/opt/sqlbot/data/excel \
2233+
-v ./data/sqlbot/file:/opt/sqlbot/data/file \
2234+
-v data/sqlbot/images:/opt/sqlbot/images \
2235+
-v data/sqlbot/logs:/opt/sqlbot/logs \
2236+
-v data/postgresql:/var/lib/postgresql/data \
2237+
--privileged=true \
2238+
dataease/sqlbot
2239+
</code></pre></div></p>
22252240
</div>
22262241
<h1 id="4">4 登录访问<a class="headerlink" href="#4" title="Permanent link">&para;</a></h1>
22272242
<div class="admonition abstract">

‎v1/installation/source_run/index.html‎

Lines changed: 35 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -2598,12 +2598,12 @@ <h3 id="24-nodejs">2.4 安装配置 nodejs<a class="headerlink" href="#24-nodej
25982598
<div class="admonition abstract">
25992599
<p>执行命令安装 nodejs。
26002600
<div class="highlight"><pre><span></span><code># 下载并安装 nodejs，node 版本可能会变化，如版本升级，请更新连接
2601-
wget https://nodejs.org/dist/latest-v22.x/node-v22.21.0-linux-x64.tar.gz
2602-
tar xvf node-v22.21.0-linux-x64.tar.gz
2603-
mv node-v22.21.0-linux-x64 /opt/node-v22.21.0
2601+
wget https://nodejs.org/dist/latest-v22.x/node-v22.21.1-linux-x64.tar.gz
2602+
tar xvf node-v22.21.1-linux-x64.tar.gz
2603+
mv node-v22.21.1-linux-x64 /opt/node-v22.21.1
26042604

26052605
# 添加环境变量
2606-
echo &quot;export PATH=\$PATH:/opt/node-v22.21.0/bin&quot; &gt;&gt; ~/.bashrc
2606+
echo &quot;export PATH=\$PATH:/opt/node-v22.21.1/bin&quot; &gt;&gt; ~/.bashrc
26072607

26082608
# 使环境变量生效
26092609
source ~/.bashrc
@@ -2612,38 +2612,38 @@ <h3 id="24-nodejs">2.4 安装配置 nodejs<a class="headerlink" href="#24-nodej
26122612
<div class="admonition abstract">
26132613
<p>验证 nodejs。
26142614
<div class="highlight"><pre><span></span><code>root@iZt4ndy6544y6f1i99ahw0Z:~# node --version
2615-
v22.21.0
2615+
v22.21.1
26162616

26172617
root@iZt4ndy6544y6f1i99ahw0Z:~# npm version
26182618
{
2619-
npm: &#39;10.9.4&#39;,
2620-
node: &#39;22.21.0&#39;,
2621-
acorn: &#39;8.15.0&#39;,
2622-
ada: &#39;2.9.2&#39;,
2623-
amaro: &#39;1.1.4&#39;,
2624-
ares: &#39;1.34.5&#39;,
2625-
brotli: &#39;1.1.0&#39;,
2626-
cjs_module_lexer: &#39;2.1.0&#39;,
2627-
cldr: &#39;47.0&#39;,
2628-
icu: &#39;77.1&#39;,
2629-
llhttp: &#39;9.3.0&#39;,
2630-
modules: &#39;127&#39;,
2631-
napi: &#39;10&#39;,
2632-
nbytes: &#39;0.1.1&#39;,
2633-
ncrypto: &#39;0.0.1&#39;,
2634-
nghttp2: &#39;1.64.0&#39;,
2635-
openssl: &#39;3.5.4&#39;,
2636-
simdjson: &#39;3.13.0&#39;,
2637-
simdutf: &#39;6.4.2&#39;,
2638-
sqlite: &#39;3.50.4&#39;,
2639-
tz: &#39;2025b&#39;,
2640-
undici: &#39;6.22.0&#39;,
2641-
unicode: &#39;16.0&#39;,
2642-
uv: &#39;1.51.0&#39;,
2643-
uvwasi: &#39;0.0.23&#39;,
2644-
v8: &#39;12.4.254.21-node.33&#39;,
2645-
zlib: &#39;1.3.1-470d3a2&#39;,
2646-
zstd: &#39;1.5.7&#39;
2619+
npm: &#39;10.9.4&#39;,
2620+
node: &#39;22.21.1&#39;,
2621+
acorn: &#39;8.15.0&#39;,
2622+
ada: &#39;2.9.2&#39;,
2623+
amaro: &#39;1.1.4&#39;,
2624+
ares: &#39;1.34.5&#39;,
2625+
brotli: &#39;1.1.0&#39;,
2626+
cjs_module_lexer: &#39;2.1.0&#39;,
2627+
cldr: &#39;47.0&#39;,
2628+
icu: &#39;77.1&#39;,
2629+
llhttp: &#39;9.3.0&#39;,
2630+
modules: &#39;127&#39;,
2631+
napi: &#39;10&#39;,
2632+
nbytes: &#39;0.1.1&#39;,
2633+
ncrypto: &#39;0.0.1&#39;,
2634+
nghttp2: &#39;1.64.0&#39;,
2635+
openssl: &#39;3.5.4&#39;,
2636+
simdjson: &#39;3.13.0&#39;,
2637+
simdutf: &#39;6.4.2&#39;,
2638+
sqlite: &#39;3.50.4&#39;,
2639+
tz: &#39;2025b&#39;,
2640+
undici: &#39;6.22.0&#39;,
2641+
unicode: &#39;16.0&#39;,
2642+
uv: &#39;1.51.0&#39;,
2643+
uvwasi: &#39;0.0.23&#39;,
2644+
v8: &#39;12.4.254.21-node.33&#39;,
2645+
zlib: &#39;1.3.1-470d3a2&#39;,
2646+
zstd: &#39;1.5.7&#39;
26472647
}
26482648
</code></pre></div></p>
26492649
</div>
@@ -2720,6 +2720,7 @@ <h4 id="322">3.2.2 配置内置向量模型<a class="headerlink" href="#322" tit
27202720
<h4 id="323-oracle-instant-client">3.2.3 Oracle Instant Client 安装<a class="headerlink" href="#323-oracle-instant-client" title="Permanent link">&para;</a></h4>
27212721
<div class="admonition abstract">
27222722
<p>为了支持 Oracle 11 以及 thick 模型，我们需要安装 Oracle Instant Client。可以到 Oracle 官网下载对应的版本，地址是 <a href="https://www.oracle.com/database/technologies/instant-client/downloads.html">https://www.oracle.com/database/technologies/instant-client/downloads.html</a></p>
2723+
<p>若不需要使用 Oracle thick 模式的话，可以略过此步骤。</p>
27232724
<p>以 Ubuntu 为例，安装示例如下：
27242725
<div class="highlight"><pre><span></span><code>root@iZt4n9ii50pwh74bs5bhuzZ:~#<span class="w"> </span>wget<span class="w"> </span>https://download.oracle.com/otn_software/linux/instantclient/2326000/instantclient-basic-linux.x64-23.26.0.0.0.zip
27252726
--2025-11-05<span class="w"> </span><span class="m">17</span>:12:57--<span class="w"> </span>https://download.oracle.com/otn_software/linux/instantclient/2326000/instantclient-basic-linux.x64-23.26.0.0.0.zip
@@ -2763,6 +2764,7 @@ <h3 id="33">3.3 源码编译<a class="headerlink" href="#33" title="Permanent li
27632764
</div>
27642765
<h3 id="34">3.4 运行<a class="headerlink" href="#34" title="Permanent link">&para;</a></h3>
27652766
<div class="admonition abstract">
2767+
<p>进入到 backend 文件夹下，执行下面的命令：</p>
27662768
<div class="highlight"><pre><span></span><code>source .venv/bin/activate
27672769

27682770
# 启动 g2-ssr，用来为 mcp 生成图形（可选）

‎v1/mcp_server/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2369,7 +2369,7 @@ <h2 id="1">1 服务配置<a class="headerlink" href="#1" title="Permanent link">
23692369
<span class="w"> </span>--restart<span class="w"> </span>unless-stopped<span class="w"> </span><span class="se">\</span>
23702370
<span class="w"> </span>-p<span class="w"> </span><span class="m">8000</span>:8000<span class="w"> </span><span class="se">\</span>
23712371
<span class="w"> </span>-p<span class="w"> </span><span class="m">8001</span>:8001<span class="w"> </span><span class="se">\</span>
2372-
<span class="w"> </span>-e<span class="w"> </span><span class="nv">SERVER_IMAGE_HOST</span><span class="o">=</span>http://47.92.75.231:8001/images/
2372+
<span class="w"> </span>-e<span class="w"> </span><span class="nv">SERVER_IMAGE_HOST</span><span class="o">=</span>http://47.92.75.231:8001/images/<span class="w"> </span><span class="se">\</span>
23732373
<span class="w"> </span>-v<span class="w"> </span>data/sqlbot/excel:/opt/sqlbot/data/excel<span class="w"> </span><span class="se">\</span>
23742374
<span class="w"> </span>-v<span class="w"> </span>./data/sqlbot/file:/opt/sqlbot/data/file<span class="w"> </span><span class="se">\</span>
23752375
<span class="w"> </span>-v<span class="w"> </span>data/sqlbot/images:/opt/sqlbot/images<span class="w"> </span><span class="se">\</span>

‎v1/search/search_index.json‎

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)