diff --git a/funasr/runtime/docs/SDK_advanced_guide_offline.md b/funasr/runtime/docs/SDK_advanced_guide_offline.md index ac876536b..43a69cd83 100644 --- a/funasr/runtime/docs/SDK_advanced_guide_offline.md +++ b/funasr/runtime/docs/SDK_advanced_guide_offline.md @@ -84,7 +84,7 @@ nohup bash run_server.sh \ --port 10095 \ --certfile ../../../ssl_key/server.crt \ --keyfile ../../../ssl_key/server.key \ - --hotwordsfile ../../hotwords.txt > log.out 2>&1 & + --hotword ../../hotwords.txt > log.out 2>&1 & ``` Introduction to run_server.sh parameters: @@ -103,7 +103,7 @@ Introduction to run_server.sh parameters: --io-thread-num: Number of IO threads that the server starts. Default is 1. --certfile : SSL certificate file. Default is ../../../ssl_key/server.crt. If you want to close ssl,set 0 --keyfile : SSL key file. Default is ../../../ssl_key/server.key. ---hotwordsfile Hotword file path, one line for each hot word, if the client provides hot words, then combined with the hot words provided by the client. Default is ../../hotwords.txt +--hotword Hotword file path, one line for each hot word, if the client provides hot words, then combined with the hot words provided by the client. Default is ../../hotwords.txt ``` ### Shutting Down the FunASR Service diff --git a/funasr/runtime/docs/SDK_advanced_guide_offline_en.md b/funasr/runtime/docs/SDK_advanced_guide_offline_en.md index e40937663..b829e67c7 100644 --- a/funasr/runtime/docs/SDK_advanced_guide_offline_en.md +++ b/funasr/runtime/docs/SDK_advanced_guide_offline_en.md @@ -79,8 +79,7 @@ nohup bash run_server.sh \ --io-thread-num 8 \ --port 10095 \ --certfile ../../../ssl_key/server.crt \ - --keyfile ../../../ssl_key/server.key \ - --hotwordsfile ../../hotwords.txt + --keyfile ../../../ssl_key/server.key > log.out 2>&1 & ``` Introduction to run_server.sh parameters: @@ -99,7 +98,6 @@ Introduction to run_server.sh parameters: --io-thread-num: Number of IO threads that the server starts. Default is 1. --certfile : SSL certificate file. Default is ../../../ssl_key/server.crt. If you want to close ssl,set 0 --keyfile : SSL key file. Default is ../../../ssl_key/server.key. ---hotwordsfile Hotword file path, one line for each hot word, if the client provides hot words, then combined with the hot words provided by the client. Default is ../../hotwords.txt ``` ### Shutting Down the FunASR Service diff --git a/funasr/runtime/docs/SDK_advanced_guide_offline_en_zh.md b/funasr/runtime/docs/SDK_advanced_guide_offline_en_zh.md index 90b096347..48c67c9a5 100644 --- a/funasr/runtime/docs/SDK_advanced_guide_offline_en_zh.md +++ b/funasr/runtime/docs/SDK_advanced_guide_offline_en_zh.md @@ -162,8 +162,7 @@ nohup bash run_server.sh \ --io-thread-num 8 \ --port 10095 \ --certfile ../../../ssl_key/server.crt \ - --keyfile ../../../ssl_key/server.key \ - --hotwordsfile ../../hotwords.txt > log.out 2>&1 & + --keyfile ../../../ssl_key/server.key > log.out 2>&1 & ``` **run_server.sh命令参数介绍** ```text @@ -180,7 +179,6 @@ nohup bash run_server.sh \ --io-thread-num 服务端启动的IO线程数,默认为 1 --certfile ssl的证书文件,默认为:../../../ssl_key/server.crt,如果需要关闭ssl,参数设置为0 --keyfile ssl的密钥文件,默认为:../../../ssl_key/server.key ---hotwordsfile 热词文件路径,每一个热词一行,如果客户端提供热词,则与客户端提供的热词合并一起使用。默认为:../../hotwords.txt ``` ### 关闭FunASR服务 diff --git a/funasr/runtime/docs/SDK_advanced_guide_offline_zh.md b/funasr/runtime/docs/SDK_advanced_guide_offline_zh.md index c1b33b6cd..ee6550108 100644 --- a/funasr/runtime/docs/SDK_advanced_guide_offline_zh.md +++ b/funasr/runtime/docs/SDK_advanced_guide_offline_zh.md @@ -166,7 +166,7 @@ nohup bash run_server.sh \ --port 10095 \ --certfile ../../../ssl_key/server.crt \ --keyfile ../../../ssl_key/server.key \ - --hotwordsfile ../../hotwords.txt > log.out 2>&1 & + --hotword ../../hotwords.txt > log.out 2>&1 & ``` **run_server.sh命令参数介绍** ```text @@ -183,7 +183,7 @@ nohup bash run_server.sh \ --io-thread-num 服务端启动的IO线程数,默认为 1 --certfile ssl的证书文件,默认为:../../../ssl_key/server.crt,如果需要关闭ssl,参数设置为0 --keyfile ssl的密钥文件,默认为:../../../ssl_key/server.key ---hotwordsfile 热词文件路径,每一个热词一行,如果客户端提供热词,则与客户端提供的热词合并一起使用。默认为:../../hotwords.txt +--hotword 热词文件路径,每一个热词一行,如果客户端提供热词,则与客户端提供的热词合并一起使用。默认为:../../hotwords.txt ``` ### 关闭FunASR服务 diff --git a/funasr/runtime/docs/SDK_advanced_guide_online.md b/funasr/runtime/docs/SDK_advanced_guide_online.md index c4fac4a03..ddc02cf89 100644 --- a/funasr/runtime/docs/SDK_advanced_guide_online.md +++ b/funasr/runtime/docs/SDK_advanced_guide_online.md @@ -73,7 +73,7 @@ nohup bash run_server_2pass.sh \ --port 10095 \ --certfile ../../../ssl_key/server.crt \ --keyfile ../../../ssl_key/server.key \ - --hotwordsfile ../../hotwords.txt > log.out 2>&1 & + --hotword ../../hotwords.txt > log.out 2>&1 & # If you want to close ssl,please add:--certfile 0 # If you want to deploy the timestamp or hotword model, please set --model-dir to the corresponding model: @@ -98,7 +98,7 @@ nohup bash run_server_2pass.sh \ --io-thread-num: Number of IO threads that the server starts. Default is 1. --certfile : SSL certificate file. Default is ../../../ssl_key/server.crt. If you want to close ssl,set 0 --keyfile : SSL key file. Default is ../../../ssl_key/server.key. ---hotwordsfile Hotword file path, one line for each hot word, if the client provides hot words, then combined with the hot words provided by the client. Default is ../../hotwords.txt +--hotword Hotword file path, one line for each hot word, if the client provides hot words, then combined with the hot words provided by the client. Default is ../../hotwords.txt ``` ### Shutting Down the FunASR Service diff --git a/funasr/runtime/docs/SDK_advanced_guide_online_zh.md b/funasr/runtime/docs/SDK_advanced_guide_online_zh.md index a8e793335..902ae7a6c 100644 --- a/funasr/runtime/docs/SDK_advanced_guide_online_zh.md +++ b/funasr/runtime/docs/SDK_advanced_guide_online_zh.md @@ -82,7 +82,7 @@ nohup bash run_server_2pass.sh \ --port 10095 \ --certfile ../../../ssl_key/server.crt \ --keyfile ../../../ssl_key/server.key \ - --hotwordsfile ../../hotwords.txt > log.out 2>&1 & + --hotword ../../hotwords.txt > log.out 2>&1 & ``` **run_server_2pass.sh命令参数介绍** ```text @@ -100,7 +100,7 @@ nohup bash run_server_2pass.sh \ --io-thread-num 服务端启动的IO线程数,默认为 1 --certfile ssl的证书文件,默认为:../../../ssl_key/server.crt,如果需要关闭ssl,参数设置为0 --keyfile ssl的密钥文件,默认为:../../../ssl_key/server.key ---hotwordsfile 热词文件路径,每一个热词一行,如果客户端提供热词,则与客户端提供的热词合并一起使用。默认为:../../hotwords.txt +--hotword 热词文件路径,每一个热词一行,如果客户端提供热词,则与客户端提供的热词合并一起使用。默认为:../../hotwords.txt ``` ### 关闭FunASR服务 diff --git a/funasr/runtime/websocket/bin/funasr-wss-server-2pass.cpp b/funasr/runtime/websocket/bin/funasr-wss-server-2pass.cpp index 4aba830cd..1c879578c 100644 --- a/funasr/runtime/websocket/bin/funasr-wss-server-2pass.cpp +++ b/funasr/runtime/websocket/bin/funasr-wss-server-2pass.cpp @@ -113,7 +113,7 @@ int main(int argc, char* argv[]) { false, "../../../ssl_key/server.key", "string"); TCLAP::ValueArg hotwordsfile( - "", "hotwordsfile", + "", "hotword", "default: ../../hotwords.txt, path of hotwordsfile" "connection", false, "../../hotwords.txt", "string"); diff --git a/funasr/runtime/websocket/bin/funasr-wss-server.cpp b/funasr/runtime/websocket/bin/funasr-wss-server.cpp index c7dba43d0..b571dbef2 100644 --- a/funasr/runtime/websocket/bin/funasr-wss-server.cpp +++ b/funasr/runtime/websocket/bin/funasr-wss-server.cpp @@ -99,7 +99,7 @@ int main(int argc, char* argv[]) { false, "../../../ssl_key/server.key", "string"); TCLAP::ValueArg hotwordsfile( - "", "hotwordsfile", + "", "hotword", "default: ../../hotwords.txt, path of hotwordsfile" "connection", false, "../../hotwords.txt", "string");