配置文件修改指南 #

中控不从命令行参数中获取任何信息，它的配置信息均来自于配置文件和环境变量。此文档将详细描述如何撰写正确的中控配置文件。

配置文件加载：文件放哪儿，用什么格式写？ #

中控的启动时，会从本地磁盘加载配置文件，如果无法找到配置文件或者文件结构不正确，那么中控将无法启动。配置文件加载遵循以下规则：

• 文件名主体为 setting，如果需要指定其他，可以在环境变量中设置 CONFIG 变量；
• 文件扩展名按照优先级顺序支持 json、toml、yaml、hcl；
• 加载时依次查询：
  • 当前目录下的 config 目录，即 ./config
  • 当前目录，即 ./
  • 当前目录的上一级，即 ../
  • 用户目录下的 .config 目录下的 ctrlsys 目录，例如 ~/.config/ctrlsys

举例说明：假设当前中控运行的目录为 /home/dev/cs，那么中控会依次查找以下文件，直到找到为止尝试加载或无一存在后报错退出：

1. /home/dev/cs/config 目录
   1. /home/dev/cs/config/setting.json
   2. /home/dev/cs/config/setting.toml
   3. /home/dev/cs/config/setting.yaml
   4. /home/dev/cs/config/setting.hcl
2. /home/dev/cs 目录
   1. /home/dev/cs/setting.json
   2. /home/dev/cs/setting.toml
   3. /home/dev/cs/setting.yaml
   4. /home/dev/cs/setting.hcl
3. /home/dev 目录
   1. /home/dev/setting.json
   2. /home/dev/setting.toml
   3. /home/dev/setting.yaml
   4. /home/dev/setting.hcl
4. /home/dev/.config/ctrlsys 目录
   1. /home/dev/.config/ctrlsys/setting.json
   2. /home/dev/.config/ctrlsys/setting.toml
   3. /home/dev/.config/ctrlsys/setting.yaml
   4. /home/dev/.config/ctrlsys/setting.hcl

使用场景：

• 对于 Kubernetes 部署，可以将配置文件放在执行目录下的 config 目录中，这样的单独目录便于挂载；
• 对于本地开发调试，可以在当前目录下防止配置文件，这样可以方便地修改配置文件；
• 对于调试中控本身，考虑到 IDE 会在临时目录中运行，可以将配置文件放在用户目录下的 .config/ctrlsys 目录中，这样可以保证配置文件的全局一致性。
• YAML 是最常见的配置格式，但是 YAML 有缩进要求，如果眼神不好且头铁的话，可以用 JSON 或者 TOML 格式凑合。

整体结构：第一层级配置参数 #

第一层级有以下配置参数，按功能分类依次介绍。

基础功能 #

注意：

• debug 开启调试模式后，会导致——
  • 配置文件解析后的配置信息会输出到控制台；
  • Web Server 的 Gin 以 Debug 模式运行；
  • 在 /debug/pprof 端点启动 pprof 服务；
  • 在 /debug/statsviz 端点启动 Statsviz 服务；
• dump_response 可以通过环境变量 DH_CS_HTTP 进行覆盖，1 表示 true，0 表示 false，其他值无效；
• dump_pcm 可以通过环境变量 DH_CS_PCM 进行覆盖，1 表示 true，0 表示 false，其他值无效；
• text_chinese_convert 支持的转换模式为——
  • “hk2s”： 繁体中文 (中国香港) → 简体中文
  • “s2hk”：简体中文 → 繁体中文 (中国香港)
  • “s2t”：简体中文 → 繁体中文
  • “s2tw”：简体中文 → 繁体中文 (中国台湾)
  • “s2twp”：简体中文 → 繁体中文 (中国台湾, 包括习用词转换)
  • “t2hk”：繁体中文 → 繁体中文 (中国香港)
  • “t2s”：繁体中文 → 简体中文
  • “t2tw”：繁体中文 → 繁体中文 (中国台湾)
  • “tw2s”：繁体中文 (中国台湾) → 简体中文
  • “tw2sp”：繁体中文 (中国台湾) → 简体中文 (包括习用词转换)

增强功能 #

按具体算法能力分类，有以下配置参数可以进行简单的开关。

ASR #

NLP #

TTS #

扩展字段 #

具体的内嵌的扩展字段的结构和说明，以下章节会逐一介绍——

Logger 配置：日志的显示和保存 #

日志配置填入 logger 字段中，具体日志配置的结构如下：

日志等级的可选字符串有以下几种：

• debug
• info
• warn
• error
• panic
• fatal

Webhook 配置：转发返回客户端的消息 #

当 Webhook 配置启用后，中控所有下发给客户端的消息都会同时转发给 Webhook 配置的 URL，Webhook 配置的 URL 必须是一个有效的 HTTP 或者 HTTPS URL，中控会将消息以 POST 的方式发送给 Webhook 配置的 URL，消息的格式为 JSON，内容与 WebSocket 会话中下发给客户端的消息一致。

发送超时为10秒，消息仅发送一次不会重试，如果返回码非 2XX，则认为发送失败，中控日志进行记录。支持接收端 HTTP Basic Auth 认证，如果需要认证，请设置 username 和 password 字段。

配置填入 webhook 字段中，具体 Webhook 配置的结构如下：

对象存储配置：返回的结果 URL 的存储位置 #

配置填入 object_storage 字段中，具体配置的结构如下——

在使用不同的存储类型时，某些字段可能不会使用，例如使用本地存储时，不会使用 bucket 和 connection_string 字段。具体按 type 区分的字段意义如下：

插件脚本配置：脚本的执行参数和内容 #

作为列表的方式填入配置文件的 script 字段中，具体配置的结构和内容参见 插件脚本 内容。

引擎供应商配置：具体供应商的连接参数 #

所有的引擎供应商的连接参数信息都使用统一的配置结构，但具体的配置项的意义和取舍会根据具体的引擎供应商进行调整，以下是通用的配置项的说明——

按各类引擎具体供应商的配置项说明如下——

ASR 引擎配置 #

注意：

1. max_connect 字段对所有 ASR 引擎均有效；
2. daily_quota 字段对所有 ASR 引擎均无效（未实现）；
3. 如需支持 URL 结果返回，即请求中的 cache_url 字段，需要在顶层配置中填写有效的 object_storage 配置；
4. ASR1 公有云部署当前已经停止服务，不再提供服务；
5. ASR4 为中间版本，已经停止开发，未进行任何对外部署；
6. ASR7 不提供私有化部署方案，需要事先部署 Azure Post-Adapter 服务，中控通过其进行连接。

NLP 引擎配置 #

注意：

1. max_connect 和 daily_quota 字段对所有 TTS 引擎均有效；
2. extra_config 对于不同的 NLP 引擎有不同的配置，具体参见以下详细说明；
3. proxy_url 仅对 NLP5 和 NLP6 有效，其他国内部署的引擎不支持也不需要代理；
4. NLP2 通过选配的 NLP2 Post-Adapter 可以实现任意临时引擎的接入，具体配置也会不尽相同；

NLP2 的 extra_config 的 JSON 字段说明：

主要面向 Post-Adapter，具体参数需要与 Adapter 约定。当 Starter 报文中 NLP 对应大模型参数未填时，使用此配置文件的中的预设配置，且仅当 adapter_target 字段为非空时，才会其他配置才会生效。

NLP5 的 extra_config 的 JSON 字段说明：

主要是使用 OpenAI 的 GPT-3 模型进行 Completion 任务，所以配置项也主要是针对 Completion 完成对话补全任务的参数。仅以此配置文件为准，Starter 报文中 NLP 对应的大模型参数直接忽略。

NLP6 的 extra_config 的 JSON 字段说明：

主要是使用 OpenAI 的 GPT-3.5/4 模型进行 Chat Completion 任务，所以配置项也有相应变化。当 Starter 报文中 NLP 对应大模型参数未填时，使用此配置文件的中的预设配置。

TTS 引擎配置 #

注意：

1. TTS5 不提供私有化部署方案，需要事先部署 Azure Post-Adapter 服务，中控通过其进行连接；
2. 如需 TTS 支持 Face Feature 需要在顶层配置中填写有效的 facefeature_service_url 地址；
3. 如需支持 URL 结果返回，即请求中的 cache_url 字段，需要在顶层配置中填写有效的 object_storage 配置；

配置文件举例 #

以下内容仅用作格式参考，不代表配置秘钥真实有效——

debug: true
dump_response: true
dump_pcm: true
dump_stat: true
cache_nlp: 0
cache_tts: 3600
network_monitor: true
allow_error: true
heuristic_extra_first: true
hide_console: false
port: 8070
grpc: 8010
endpoint: /v1
nlp_answer_replace:
  - "以上信息由墨迹天气为您播报。": ""
  - "商汤": ""
asr_result_replace:
  - "张平": "张屏"
  - "裕隐": "郁衍"
  - "欲演": "郁衍"
  - "裕演": "郁衍"
expire_date: 2023-12-31
auth_required: true
auth_token:
  - 2WJO7SV2GVAPPBDR5HBZME3YFQ

fallback_geolocation: 北京市
geolocation_service_url: https://dhc.softsugar.com/ipgeo/query?ip=%s

facefeature_service_url: ws://103.177.28.202:58090/ff
tts_silence_padding_msec: 100

object_storage:
  type: local
  local_path: /tmp/ctrlsys-storage/
  endpoint: http://localhost:8070/object

webhook:
  endpoint: http://localhost:8888/print
  username: Hello
  password: World

logger:
  path: runtime.log
  one: debug
  client: debug
  server: info
  mock: warn
  auth: info
  utility: debug
  driver_asr: info
  driver_nlp: debug
  driver_tts: debug
  worker_asr: debug
  worker_asr_nlp: debug
  worker_asr_nlp2: debug
  worker_nlp: debug
  worker_echo: debug
  worker_event: debug
  worker_tts: debug

asr5:
  service_url: ws://14.215.130.140:10088/
  max_connect: 1

nlp2:
  service_url: http://14.215.130.140:10080/model/reply
  product_id: UQ3XJEID
  extra_config: '{"adapter_target":"sensechat"}'

tts3:
  service_url: ws://103.177.28.202:58086

script:
  - name: "set_port"
    weight: 1
    timeout: 1s
    entrypoint: server_start
    repl: false
    async: false
    code: |
      server_config.port = 8060      

  - entrypoint: session_start
    repl: false
    enabled: true
    code: |
      print("Got old lang_model:", starter_request.nlp.model)
      if starter_request.nlp.model == "sensechat_waic_boc":
        starter_request.nlp.model = "minimax"
        print("Update lang_model:", starter_request.nlp.model)