feat:Added some documentation. (#4085)

* feat:Added some documentation.

* feat:Added some documentation.

* feat:Added some documentation.

---------

Co-authored-by: yuehuazhang <yuehuazhang@tencent.com>

libs/chatchat-server/README.md

@@ -13,14 +13,18 @@ pip install langchain-chatchat -U
 > 后面我们会提供一个一键初始化的脚本，现在您可以手动复制配置文件
 > 请注意：这个命令会清空数据库，如果您有重要数据，请备份
  ```shell
-cd chatchat-server/
+cd chatchat-server/chatchat
-mkdir ~/.config/chatchat/
+mkdir -p ~/.config/chatchat/
 cp -r configs ~/.config/chatchat/
 cp -r data ~/.config/chatchat/
 cp -r img ~/.config/chatchat/
 ```
 
-> 当项目安装完成，配置这个`model_providers.yaml`文件，即可完成自定义平台加载
+> 当配置文件复制完成后，配置拷贝后路径的`model_providers.yaml`文件，即可完成自定义平台加载
+```shell
+cd ~/.config/chatchat
+vim model_providers.yaml
+```
 > 
 > 注意: 在您配置平台之前，请确认平台依赖完整，例如智谱平台，您需要安装智谱sdk `pip install zhipuai`
 > 
@@ -29,13 +33,37 @@ cp -r img ~/.config/chatchat/
  
 - 启动服务
 ```shell
-chatchat  -a
+chatchat -a
 ```
 
 
 
 #### 源码启动chatchat-server
- 
+- 安装chatchat
+```shell
+git clone https://github.com/chatchat-space/Langchain-Chatchat.git
+```
+- 复制配置文件
+> 后面我们会提供一个一键初始化的脚本，现在您可以手动复制配置文件
+> 请注意：这个命令会清空数据库，如果您有重要数据，请备份
+ ```shell
+cd Langchain-Chatchat/libs/chatchat-server/chatchat
+mkdir -p ~/.config/chatchat/
+cp -r configs ~/.config/chatchat/
+cp -r data ~/.config/chatchat/
+cp -r img ~/.config/chatchat/
+```
+
+> 当配置文件复制完成后，配置拷贝后路径的`model_providers.yaml`文件，即可完成自定义平台加载
+```shell
+cd ~/.config/chatchat
+vim model_providers.yaml
+```
+> 
+> 注意: 在您配置平台之前，请确认平台依赖完整，例如智谱平台，您需要安装智谱sdk `pip install zhipuai`
+> 
+> 详细配置请参考[README.md](../model-providers/README.md)
+
 - 初始化仓库
 > 请注意：这个命令会清空数据库，如果您有重要数据，请备份
 ```shell
@@ -44,5 +72,5 @@ python init_database.py
 ```
 - 启动服务
 ```shell
-python chatchat-server/chatchat/startup.py -a
+python startup.py -a
 ```

libs/chatchat-server/chatchat/configs/model_providers.yaml

@@ -25,11 +25,15 @@ xinference:
       model_credentials:
         server_url: 'http://127.0.0.1:9997/'
         model_uid: 'chatglm3-6b'
-    - model: 'bge-m3'
+    - model: 'bge-large-zh-v1.5'
-      model_type: 'embeddings'
+      model_type: 'text-embedding'
       model_credentials:
         server_url: 'http://127.0.0.1:9997/'
-        model_uid: 'bge-m3'
+        model_uid: 'bge-large-zh-v1.5'
+
+zhipuai:
+  provider_credential:
+    api_key: 'd4fa0690b6dfa205204cae2e12aa6fb6.1'
 
 ollama:
   model_credential:
@@ -37,4 +41,4 @@ ollama:
       model_type: 'llm'
       model_credentials:
         base_url: 'http://172.21.192.1:11434'
-        mode: 'completion'
+        mode: 'completion'

libs/model-providers/README.md

@@ -139,7 +139,6 @@ $ pip install zhipuai
 ```yaml
 
 zhipuai:
-
   provider_credential:
     api_key: 'd4fa0690b6dfa205204cae2e12aa6fb6.2'
 ```

libs/model-providers/model_providers.yaml

@@ -25,9 +25,20 @@ xinference:
       model_credentials:
         server_url: 'http://127.0.0.1:9997/'
         model_uid: 'chatglm3-6b'
-
+    - model: 'bge-large-zh-v1.5'
+      model_type: 'text-embedding'
+      model_credentials:
+        server_url: 'http://127.0.0.1:9997/'
+        model_uid: 'bge-large-zh-v1.5'
 
 zhipuai:
-
   provider_credential:
-    api_key: 'd4fa0690b6dfa205204cae2e12aa6fb6.1'
+    api_key: 'd4fa0690b6dfa205204cae2e12aa6fb6.1'
+
+ollama:
+  model_credential:
+    - model: 'llama3'
+      model_type: 'llm'
+      model_credentials:
+        base_url: 'http://172.21.192.1:11434'
+        mode: 'completion'