Merge pull request #2189 from yt605155624/fix_name_bug

[doc]update server readme

Author: yt605155624

demos/speech_server/README.md

@@ -8,7 +8,7 @@ http://0.0.0.0:8010/docs
 
 ### 【POST】/asr/offline
 
-说明：上传16k,16bit wav文件，返回 offline 语音识别模型识别结果
+说明：上传 16k, 16bit wav 文件，返回 offline 语音识别模型识别结果
 
 返回: JSON
 
@@ -26,11 +26,11 @@ http://0.0.0.0:8010/docs
 
 ### 【POST】/asr/offlinefile
 
-说明：上传16k,16bit wav文件，返回 offline 语音识别模型识别结果 + wav数据的base64
+说明：上传16k,16bit wav文件，返回 offline 语音识别模型识别结果 + wav 数据的 base64
 
 返回: JSON
 
-前端接口： 音频文件识别(播放这段base64还原后记得添加wav头，采样率16k, int16，添加后才能播放)
+前端接口： 音频文件识别(播放这段base64还原后记得添加 wav 头，采样率 16k, int16，添加后才能播放)
 
 示例:
 
@@ -48,7 +48,7 @@ http://0.0.0.0:8010/docs
 
 ### 【POST】/asr/collectEnv
 
-说明： 通过采集环境噪音，上传16k, int16 wav文件，来生成后台VAD的能量阈值， 返回阈值结果
+说明： 通过采集环境噪音，上传 16k, int16 wav 文件，来生成后台 VAD 的能量阈值， 返回阈值结果
 
 前端接口：ASR-环境采样
 
@@ -64,9 +64,9 @@ http://0.0.0.0:8010/docs
 
 ### 【GET】/asr/stopRecord
 
-说明：通过 GET 请求 /asr/stopRecord, 后台停止接收 offlineStream 中通过 WS协议 上传的数据
+说明：通过 GET 请求 /asr/stopRecord, 后台停止接收 offlineStream 中通过 WS 协议 上传的数据
 
-前端接口：语音聊天-暂停录音（获取NLP，播放TTS时暂停）
+前端接口：语音聊天-暂停录音（获取 NLP，播放 TTS 时暂停）
 
 返回: JSON
 
@@ -80,9 +80,9 @@ http://0.0.0.0:8010/docs
 
 ### 【GET】/asr/resumeRecord
 
-说明：通过 GET 请求 /asr/resumeRecord, 后台停止接收 offlineStream 中通过 WS协议 上传的数据
+说明：通过 GET 请求 /asr/resumeRecord, 后台停止接收 offlineStream 中通过 WS 协议 上传的数据
 
-前端接口：语音聊天-恢复录音（TTS播放完毕时，告诉后台恢复录音）
+前端接口：语音聊天-恢复录音（ TTS 播放完毕时，告诉后台恢复录音）
 
 返回: JSON
 
@@ -100,16 +100,16 @@ http://0.0.0.0:8010/docs
 
 前端接口：语音聊天-开始录音，持续将麦克风语音传给后端，后端推送语音识别结果
 
-返回：后端返回识别结果，offline模型识别结果， 由WS推送
+返回：后端返回识别结果，offline 模型识别结果， 由WS推送
 
 
 ### 【Websocket】/ws/asr/onlineStream
 
-说明：通过 WS 协议，将前端音频持续上传到后台，前端采集 16k，Int16 类型的PCM片段，持续上传到后端
+说明：通过 WS 协议，将前端音频持续上传到后台，前端采集 16k，Int16 类型的 PCM 片段，持续上传到后端
 
 前端接口：ASR-流式识别开始录音，持续将麦克风语音传给后端，后端推送语音识别结果
 
-返回：后端返回识别结果，online模型识别结果， 由WS推送
+返回：后端返回识别结果，online 模型识别结果， 由 WS 推送
 
 ## NLP
 
@@ -202,7 +202,7 @@ http://0.0.0.0:8010/docs
 
 ### 【POST】/tts/offline
 
-说明：获取TTS离线模型音频
+说明：获取 TTS 离线模型音频
 
 前端接口：TTS-端到端合成
 
@@ -272,7 +272,7 @@ curl -X 'POST' \
 
 ### 【POST】/vpr/recog
 
-说明：声纹识别，识别文件，提取文件的声纹信息做比对 音频 16k, int 16 wav格式
+说明：声纹识别，识别文件，提取文件的声纹信息做比对 音频 16k, int 16 wav 格式
 
 前端接口：声纹识别-上传音频，返回声纹识别结果
 
@@ -383,9 +383,9 @@ curl -X 'GET' \
 
 ### 【GET】/vpr/database64
 
-说明： 根据 vpr_id 获取用户vpr时注册使用音频转换成 16k, int16 类型的数组，返回base64编码
+说明： 根据 vpr_id 获取用户 vpr 时注册使用音频转换成 16k, int16 类型的数组，返回 base64 编码
 
-前端接口：声纹识别-获取vpr对应的音频（注意：播放时需要添加 wav头，16k,int16, 可参考tts播放时添加wav的方式，注意更改采样率）
+前端接口：声纹识别-获取 vpr 对应的音频（注意：播放时需要添加 wav头，16k,int16, 可参考 tts 播放时添加 wav 的方式，注意更改采样率）
 
 访问示例：
 
@@ -401,6 +401,4 @@ curl -X 'GET' \
   "code": 0,
   "result":"AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
   "message": "ok"
-```
-
-
+```

demos/speech_server/README_cn.md

@@ -1,16 +1,16 @@
 # Paddle Speech Demo
 
-PaddleSpeechDemo是一个以PaddleSpeech的语音交互功能为主体开发的Demo展示项目，用于帮助大家更好的上手PaddleSpeech以及使用PaddleSpeech构建自己的应用。
+PaddleSpeechDemo 是一个以 PaddleSpeech 的语音交互功能为主体开发的 Demo 展示项目，用于帮助大家更好的上手 PaddleSpeech 以及使用 PaddleSpeech 构建自己的应用。
 
-智能语音交互部分使用PaddleSpeech，对话以及信息抽取部分使用PaddleNLP，网页前端展示部分基于Vue3进行开发
+智能语音交互部分使用 PaddleSpeech，对话以及信息抽取部分使用 PaddleNLP，网页前端展示部分基于 Vue3 进行开发
 
 主要功能：
 
-+ 语音聊天：PaddleSpeech的语音识别能力+语音合成能力，对话部分基于PaddleNLP的闲聊功能
-+ 声纹识别：PaddleSpeech的声纹识别功能展示
++ 语音聊天：PaddleSpeech 的语音识别能力+语音合成能力，对话部分基于 PaddleNLP 的闲聊功能
++ 声纹识别：PaddleSpeech 的声纹识别功能展示
 + 语音识别：支持【实时语音识别】，【端到端识别】，【音频文件识别】三种模式
 + 语音合成：支持【流式合成】与【端到端合成】两种方式
-+ 语音指令：基于PaddleSpeech的语音识别能力与PaddleNLP的信息抽取，实现交通费的智能报销
++ 语音指令：基于 PaddleSpeech 的语音识别能力与 PaddleNLP 的信息抽取，实现交通费的智能报销
 
 运行效果：
 
@@ -32,23 +32,21 @@ cd model
 wget https://bj.bcebos.com/paddlenlp/applications/speech-cmd-analysis/finetune/model_state.pdparams
 ```
 
-
 ### 前端环境安装
 
-前端依赖node.js ，需要提前安装，确保npm可用，npm测试版本8.3.1，建议下载[官网](https://nodejs.org/en/)稳定版的node.js
+前端依赖 `node.js` ，需要提前安装，确保 `npm` 可用，`npm` 测试版本 `8.3.1`，建议下载[官网](https://nodejs.org/en/)稳定版的 `node.js`
 
 ```
 # 进入前端目录
 cd web_client
 
-# 安装yarn，已经安装可跳过
+# 安装 `yarn`，已经安装可跳过
 npm install -g yarn
 
 # 使用yarn安装前端依赖
 yarn install
 ```
 
-
 ## 启动服务
 
 ### 开启后端服务
@@ -66,18 +64,18 @@ cd web_client
 yarn dev --port 8011
 ```
 
-默认配置下，前端中配置的后台地址信息是localhost，确保后端服务器和打开页面的游览器在同一台机器上，不在一台机器的配置方式见下方的FAQ：【后端如果部署在其它机器或者别的端口如何修改】
+默认配置下，前端中配置的后台地址信息是 localhost，确保后端服务器和打开页面的游览器在同一台机器上，不在一台机器的配置方式见下方的 FAQ：【后端如果部署在其它机器或者别的端口如何修改】
 ## FAQ 
 
 #### Q: 如何安装node.js
 
-A： node.js的安装可以参考[【菜鸟教程】](https://www.runoob.com/nodejs/nodejs-install-setup.html), 确保npm可用
+A： node.js的安装可以参考[【菜鸟教程】](https://www.runoob.com/nodejs/nodejs-install-setup.html), 确保 npm 可用
 
 #### Q：后端如果部署在其它机器或者别的端口如何修改
 
 A：后端的配置地址有分散在两个文件中
 
-修改第一个文件`PaddleSpeechWebClient/vite.config.js`
+修改第一个文件 `PaddleSpeechWebClient/vite.config.js`
 
 ```
 server: {
@@ -92,7 +90,7 @@ server: {
   }
 ```
 
-修改第二个文件`PaddleSpeechWebClient/src/api/API.js`（Websocket代理配置失败，所以需要在这个文件中修改）
+修改第二个文件 `PaddleSpeechWebClient/src/api/API.js`（ Websocket 代理配置失败，所以需要在这个文件中修改）
 
 ```
 // websocket （这里改成后端所在的接口）
@@ -107,9 +105,6 @@ A：这里主要是游览器安全策略的限制，需要配置游览器后重
 
 chrome设置地址: chrome://flags/#unsafely-treat-insecure-origin-as-secure
 
-
-
-
 ## 参考资料
 
 vue实现录音参考资料：https://blog.csdn.net/qq_41619796/article/details/107865602#t1