refactor: add docs

Author: xuwei-fit2cloud

docs/faq/datasource.md

@@ -17,3 +17,11 @@
 
     ![示例](../img/faq/dameng_issue.jpg)
 
+## 2 数据源连接无效？
+
+!!! Abstract ""
+    数据源本身服务正常，但添加到 SQLBot 中时，提示数据源连接无效。可能的原因：
+
+    - SQLBot 默认以 docker 方式运行，在 SQLBot 容器中访问 localhost，或者 127.0.0.1 等本地地址时，均指向 SQLBot 容器自身，而不是 SQLBot 容器外的其他服务。此时可以将数据源的 IP 换成服务器的内网或公网 IP 即可，如果是本机服务，也可以输入 host.docker.internal
+    - docker network 配置有问题，导致容器内无法访问到容器外的地址，可以试着将 docker network mode 调整为 host，然后重启服务
+    - 数据源服务器的防火墙是否开放了对应的端口，公有云的服务器还需要检查服务器对应的安全组规则是否开放了对应端口

docs/faq/smart_question_description.md

@@ -12,7 +12,7 @@
 
     术语示例如下图所示：
 
-![professional..png](../img/faq/professional..png)
+    ![professional..png](../img/faq/professional..png)
 
 ## 3 SQL 示例怎么使用？
 
@@ -21,5 +21,38 @@
 
     SQL 示例如下图所示：
 
-![data_training.png](../img/faq/data_training.png)
+    ![data_training.png](../img/faq/data_training.png)
 
+## 4 SQLBot 在哪些方面会影响到对 token 的消耗？
+
+!!! Abstract ""
+    问数的时候对 token 的消耗主要有几个地方：
+    
+    - SQLBot 自身的提示词模板
+    - 匹配到和问数相关的数据表结构，包括描述
+    - 匹配到和问数相关的术语
+    - 匹配到和问数相关的 SQL示例
+    - 匹配到和问数相关的自定义提示词
+
+    如果上面这几个地方内容多的话，对 token 的消耗会比较大，另外，在问数过程中的上下文也会有一定的 token 消耗。
+
+## 5  如何提升 SQLBot 问数的准确率？
+
+!!! Abstract ""
+    可以通过以下几个方面的设置来提升 SQLBot 的问数准确率：
+    
+    - 调整问题的问法，表达意图更清晰一些
+    - 在 SQLBot 中为数据源、数据表、数据字段添加和常见问题相关的描述信息
+    - 在术语配置里将一些数据源中的业务概念添加为术语，让大模型更好的理解问题
+    - 在 SQL 示例库中添加一些数据源常见的查询示例，让大模型可以学习如何正确生成 SQL
+    - 在自定义提示词（商业版）中针对数据源添加一些和常见问题场景相关的约束
+    - 若存在多表关联查询的场景，可以在数据源的表关系管理中，给关联表设置字段的关联关系
+    - 试试其他的大模型，换个强一些的大模型，虽然简单粗暴，但效果明显
+
+## 6 问数过程中大模型有响应，但 SQLBot 显示解析响应结果出错
+
+!!! Abstract ""
+    SQLBot 对大模型返回的问数结果的结构是有要求的，SQLBot 在提示词模板中对该格式有明确定义。在使用过程中，有些大模型由于理解能力问题，并未按要求返回相应格式的数据，会导致 SQLBot 无法解析返回结果，出现类似下图的错误： 
+    ![faq_parse_answer.png](../img/faq/faq_parse_answer.png)
+
+    此时建议更换其他模型试试。