From dc2821586892da7e3c2242c7c37f696d209ac772 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=8F=B2=E9=B8=BF=E5=AE=87?= Date: Mon, 21 Oct 2024 19:51:01 +0800 Subject: [PATCH] =?UTF-8?q?=E4=BF=AE=E5=A4=8D=20404=20=E9=93=BE=E6=8E=A5?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: 史鸿宇 --- .../\345\211\215\350\250\200.md" | 12 +++++----- ...50\347\275\262\346\214\207\345\215\227.md" | 3 ++- ...04\345\273\272\346\214\207\345\215\227.md" | 22 +++++++++---------- ...50\347\275\262\346\214\207\345\215\227.md" | 2 +- 4 files changed, 20 insertions(+), 19 deletions(-) diff --git "a/docs/user-guide/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/\345\211\215\350\250\200.md" "b/docs/user-guide/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/\345\211\215\350\250\200.md" index 1846ed6e2..2f03aeedc 100644 --- "a/docs/user-guide/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/\345\211\215\350\250\200.md" +++ "b/docs/user-guide/\344\275\277\347\224\250\346\214\207\345\215\227/\347\272\277\344\270\212\346\234\215\345\212\241/\345\211\215\350\250\200.md" @@ -26,9 +26,9 @@ - 使用过程中涉及的非工具本身验证功能所用的用户名和密码，不作他用，且不会被保存在系统环境中。 - 在您进行对话或操作前应当确认您为应用程序的所有者或已获得所有者的充足授权同意。 - 对话结果中可能包含您所分析应用的内部信息和相关数据，请妥善管理。 -- 除非法律法规或双方合同另有规定，华为公司对分析结果不做任何明示或暗示的声明和保证,不对分析结果的适销性、满意度、非侵权性或特定用途适用性等作出任何保证或者承诺。 +- 除非法律法规或双方合同另有规定，openEuler 社区对分析结果不做任何明示或暗示的声明和保证,不对分析结果的适销性、满意度、非侵权性或特定用途适用性等作出任何保证或者承诺。 - 您根据分析记录所采取的任何行为均应符合法律法规的要求，并由您自行承担风险。 -- 未经所有者授权，任何个人或组织均不得使用应用程序及相关分析记录从事任何活动。华为公司不对由此造成的一切后果负责，亦不承担任何法律责任。必要时，将追究其法律责任。 +- 未经所有者授权，任何个人或组织均不得使用应用程序及相关分析记录从事任何活动。openEuler 社区不对由此造成的一切后果负责，亦不承担任何法律责任。必要时，将追究其法律责任。 ### openEuler Copilot System 简介 @@ -61,7 +61,7 @@ openEuler Copilot System 界面主要由如图 1 所示的区域组成，各个 | 区域 | 名称 | 说明 | |-----|------------|----------------------------------------------------------------| -| 1 | 设置管理区 | 提供账号登录和退出操作入口和明亮/黑暗模式切换功能 | -| 2 | 对话管理区 | 用于用户新建对话、对话历史记录管理和对话历史记录批量删除操作 | -| 3 | 对话区 | 用于用户和 openEuler Copilot System 的对话聊天 | -| 4 | 服务协议和隐私政策区 | 提供查看服务协议和隐私政策入口 | +| 1 | 设置管理区 | 提供账号登录和退出操作入口和明亮/黑暗模式切换功能 | +| 2 | 对话管理区 | 用于用户新建对话、对话历史记录管理和对话历史记录批量删除操作 | +| 3 | 对话区 | 用于用户和 openEuler Copilot System 的对话聊天 | +| 4 | 服务协议和隐私政策区 | 提供查看服务协议和隐私政策入口 | diff --git "a/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\227\240\347\275\221\347\273\234\347\216\257\345\242\203\344\270\213\351\203\250\347\275\262\346\214\207\345\215\227.md" "b/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\227\240\347\275\221\347\273\234\347\216\257\345\242\203\344\270\213\351\203\250\347\275\262\346\214\207\345\215\227.md" index db0c45435..2c1079466 100644 --- "a/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\227\240\347\275\221\347\273\234\347\216\257\345\242\203\344\270\213\351\203\250\347\275\262\346\214\207\345\215\227.md" +++ "b/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\227\240\347\275\221\347\273\234\347\216\257\345\242\203\344\270\213\351\203\250\347\275\262\346\214\207\345\215\227.md" @@ -41,7 +41,7 @@ openEuler Copilot System 是一款智能问答工具，使用 openEuler Copilot 注意： -1. 若无 GPU 或 NPU 资源，建议通过调用 OpenAI 接口的方式来实现功能。(接口样例：https://dashscope.aliyuncs.com/compatible-mode/v1/chat/completions) +1. 若无 GPU 或 NPU 资源，建议通过调用 OpenAI 接口的方式来实现功能。(接口样例：) 2. 调用第三方 OpenAI 接口的方式不需要安装高版本的 python (>=3.9.9) 3. 英伟达 GPU 对 Docker 的支持必需要新版本 Docker (>= v25.4.0) @@ -214,6 +214,7 @@ openEuler Copilot System 是一款智能问答工具，使用 openEuler Copilot # 下载目录以home为例，进入 openEuler Copilot System 仓库的Helm配置文件目录 cd /home/euler-copilot-framework ``` + ```bash ll ``` diff --git "a/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272\346\214\207\345\215\227.md" "b/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272\346\214\207\345\215\227.md" index fa84df29f..53ef0ff92 100644 --- "a/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272\346\214\207\345\215\227.md" +++ "b/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\346\234\254\345\234\260\350\265\204\344\272\247\345\272\223\346\236\204\345\273\272\346\214\207\345\215\227.md" @@ -19,15 +19,15 @@ chmod -R 755 /home/docs ``` -将文件存放的源目录映射至 RAG 容器目标目录，源目录的配置在 https://gitee.com/openeuler/euler-copilot-framework/blob/master/euler-copilot-helm/chart/values.yaml 中，下面是文件中具体配置映射源目录的的配置方法： +将文件存放的源目录映射至 RAG 容器目标目录，源目录的配置在 中，下面是文件中具体配置映射源目录的的配置方法： ![配置映射源目录](./pictures/本地资产库构建/配置映射源目录.png) -中间层的配置（链接源目录和目标目录的配置）在 https://gitee.com/openeuler/euler-copilot-framework/blob/master/euler-copilot-helm/chart/templates/rag/rag-deployment.yaml 中，下面是文件中具体映射中间层的的配置方法： +中间层的配置（链接源目录和目标目录的配置）在 中，下面是文件中具体映射中间层的的配置方法： ![配置映射中间层](./pictures/本地资产库构建/配置映射中间层.png) -目标目录的配置在 https://gitee.com/openeuler/euler-copilot-framework/blob/master/euler-copilot-helm/chart/templates/rag/rag-deployment.yaml 中，下面是文件中具体映射目标目录的配置方法： +目标目录的配置在 中，下面是文件中具体映射目标目录的配置方法： ![配置映射目标目录](./pictures/本地资产库构建/配置映射目标目录.png) @@ -121,7 +121,7 @@ python3 scripts/rag_kb_manager.pyc --method init_database_info --database_url p **注意：** -**{dabase_url}**为 k8s 集群内访问 postgres 服务的 url，请根据具体情况修改，一般为 **{postgres_servive_name}-{{ .Release.Name }}.\.svc.cluster.local** 格式，其中 **{postgres_servive_name}** 可以从 https://gitee.com/openeuler/euler-copilot-framework/blob/master/euler-copilot-helm/chart/templates/pgsql/pgsql-service.yaml 找到： +**{dabase_url}**为 k8s 集群内访问 postgres 服务的 url，请根据具体情况修改，一般为 **{postgres_servive_name}-{{ .Release.Name }}.\.svc.cluster.local** 格式，其中 **{postgres_servive_name}** 可以从 找到： ![k8s集群中postgres服务的名称](./pictures/本地资产库构建/k8s集群中postgres服务的名称.png) @@ -131,7 +131,7 @@ python3 scripts/rag_kb_manager.pyc --method init_database_info --database_url p helm install my-release-name --namespace my-namespace path/to/chart ``` -**database_port** 的信息可以在 https://gitee.com/openeuler/euler-copilot-framework/blob/master/euler-copilot-helm/chart/templates/pgsql/pgsql-service.yaml 中查看，以下为字段所在位置（一般为5432）： +**database_port** 的信息可以在 中查看，以下为字段所在位置（一般为5432）： ![postgres服务端口](./pictures/本地资产库构建/postgres服务端口.png) @@ -151,7 +151,7 @@ helm install my-release-name --namespace my-namespace path/to/chart python3 scripts/rag_kb_manager.pyc --method init_rag_info --rag_url http://{rag_url}:{rag_port} ``` -**{rag_url}** 为 0.0.0.0，**{rag_port}** 可以从 https://gitee.com/openeuler/euler-copilot-framework/blob/master/euler-copilot-helm/chart/templates/rag/rag-service.yaml 中获取（一般为8005）： +**{rag_url}** 为 0.0.0.0，**{rag_port}** 可以从 中获取（一般为8005）： ![rag_port](./pictures/本地资产库构建/rag_port.png) @@ -202,7 +202,7 @@ root@pgsql-deploy-b4cc79794-qn8zd:/tmp# psql -U postgres ![数据库初始化](./pictures/本地资产库构建/数据库初始化.png) -- ##### 清空数据库（注意） +- #### 清空数据库（注意） 假设您想清空 RAG 产生的所有数据库数据，可以使用下面命令（**此命令会清空整个数据库，需谨慎操作！**）。 @@ -215,7 +215,7 @@ python3 scripts/rag_kb_manager.pyc --method clear_database 下列指令若不指定 kb_name，则默认资产名为 default_test（ps：Copilot 不允许存在两个同名的资产）： -- ##### 创建资产（可重复） +- #### 创建资产（可重复） ```bash python3 scripts/rag_kb_manager.pyc --method create_kb --kb_name default_test @@ -229,7 +229,7 @@ python3 scripts/rag_kb_manager.pyc --method create_kb --kb_name default_test ![重复创建资产失败](./pictures/本地资产库构建/重复创建资产失败.png) -- ##### 删除资产（可重复） +- #### 删除资产（可重复） ```bash python3 scripts/rag_kb_manager.pyc --method del_kb --kb_name default_test @@ -243,7 +243,7 @@ python3 scripts/rag_kb_manager.pyc --method del_kb --kb_name default_test ![删除不存在的资产失败](./pictures/本地资产库构建/删除不存在的资产失败.png) -- ##### 查询资产（可重复） +- #### 查询资产（可重复） ```bash python3 scripts/rag_kb_manager.pyc --method query_kb @@ -377,7 +377,7 @@ python3 scripts/rag_kb_manager.pyc --method stop_corpus_uploading_job ## 网页端查看语料上传进度 -您可以灵活设置端口转发规则，通过执行如下命令将容器端口映射到主机上的指定端口，并在任何设备上通过访问 http://<主机IP>:<映射端口>（例如 http://192.168.16.178:3000/ ）来查看语料上传的详细情况。 +您可以灵活设置端口转发规则，通过执行如下命令将容器端口映射到主机上的指定端口，并在任何设备上通过访问 http://<主机IP>:<映射端口>（例如 ）来查看语料上传的详细情况。 ```bash kubectl port-forward rag-deploy-service-5b7887644c-sm58z 3000:8005 -n euler-copilot --address=0.0.0.0 diff --git "a/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\347\275\221\347\273\234\347\216\257\345\242\203\344\270\213\351\203\250\347\275\262\346\214\207\345\215\227.md" "b/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\347\275\221\347\273\234\347\216\257\345\242\203\344\270\213\351\203\250\347\275\262\346\214\207\345\215\227.md" index 0f696fc54..ca506998a 100644 --- "a/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\347\275\221\347\273\234\347\216\257\345\242\203\344\270\213\351\203\250\347\275\262\346\214\207\345\215\227.md" +++ "b/docs/user-guide/\351\203\250\347\275\262\346\214\207\345\215\227/\347\275\221\347\273\234\347\216\257\345\242\203\344\270\213\351\203\250\347\275\262\346\214\207\345\215\227.md" @@ -41,7 +41,7 @@ openEuler Copilot System 是一款智能问答工具，使用 openEuler Copilot 注意： -1. 若无 GPU 或 NPU 资源，建议通过调用 OpenAI 接口的方式来实现功能。(接口样例：https://dashscope.aliyuncs.com/compatible-mode/v1/chat/completions 参考链接：[API-KEY的获取与配置](https://help.aliyun.com/zh/dashscope/developer-reference/acquisition-and-configuration-of-api-key?spm=a2c4g.11186623.0.0.30e7694eaaxxGa)) +1. 若无 GPU 或 NPU 资源，建议通过调用 OpenAI 接口的方式来实现功能。(接口样例： 参考链接：[API-KEY的获取与配置](https://help.aliyun.com/zh/dashscope/developer-reference/acquisition-and-configuration-of-api-key?spm=a2c4g.11186623.0.0.30e7694eaaxxGa)) 2. 调用第三方 OpenAI 接口的方式不需要安装高版本的 python (>=3.9.9) 3. 英伟达 GPU 对 Docker 的支持必需要新版本 Docker (>= v25.4.0) -- Gitee