为 Voice Gateway 配置环境变量
可以通过定义 Docker 环境变量来配置 IBM® Voice Gateway。指定环境变量的位置取决于部署 Voice Gateway 的位置：
- Docker 引擎：在首次在 Docker 引擎上部署 Voice Gateway 时创建的
docker-compose.yml文件中设置变量。 - IBM® Cloud Kubernetes Service：在将 Voice Gateway 部署到 IBM Cloud 中的 Kubernetes 时创建的
deploy.json文件中，将变量设置为名称/值对。
这些 docker-compose.yml 和 deploy.json 文件，每个文件都包含了如何配置环境变量的示例。
高级 JSON 配置：在单独的 JSON 文件中指定和存储租户配置，然后从 Voice Gateway Docker 配置中的环境变量引用该文件。与租户无关的配置（例如服务器配置）通过 Docker 环境变量来指定。有关要在 JSON 文件中配置哪些设置的详细信息，请参阅在多租户 JSON 配置中配置租户和高级 JSON 配置属性。
重要信息：要使任何配置更改生效，必须保存配置文件，然后重新部署 Voice Gateway。
虽然可在单个文件中定义 SIP Orchestrator 和 Media Relay，但每个组件都使用不同的环境变量，以下部分中概括了这些变量。
- SIP Orchestrator 环境变量
- Media Relay 环境变量
- Speech to Text Adapter 环境变量
- Text to Speech Adapter 环境变量
- 出站呼叫环境变量
- 监视 REST API 环境变量
SIP Orchestrator 环境变量
下表列出可用于配置 SIP Orchestrator 的所有 Docker 环境变量。
核心部署配置
无论 Voice Gateway 托管的租户数量如何，以下环境变量在整个部署中都适用。对于单租户环境和多租户 JSON 配置，请在部署配置中定义这些变量。
常规部署配置
| 环境变量 | 缺省值 | 描述 |
|---|---|---|
MEDIA_RELAY_HOST |
localhost:8080 |
Media Relay 的主机名，WebSocket 服务器和 UDP 套接字将绑定到该主机名。通常设置为 Media Relay 服务名称（例如 vgw.media.relay:8080）。 |
MULTI_TENANT_CONFIG_FILE |
无 | 用于配置多租户 JSON 配置的 JSON 文件的路径。V1.0.0.2 和更高版本。 |
NOTIFY_CONVERSATION_ON_FILTERED_UTTERANCES |
false |
当属性设置为 true 时，Voice Gateway 会使用文字“vgwSTTResultFiltered”向 Watson Assistant 启动新轮次，以指示该发声由于低置信度级别而被过滤掉。V1.0.2 和更高版本。 |
NOTIFY_CONVERSATION_ON_NETWORK_EVENTS |
false |
当设置为 true 并检测到网络错误时，Voice Gateway 使用文本“vgwNetworkWarningMessage”启动面向 Watson Assistant 服务的轮次。vgwNetworkWarnings 状态变量包含当前轮次期间发生的网络事件的列表。如果该标志设置为 false，那么将在 vgwNetworkWarnings 状态变量中的下一个轮次事件中发送当前轮次期间发生的网络事件的列表。V1.0.0.5
和更高版本。 |
NOTIFY_CONVERSATION_ON_MEDIA_CHANGE |
false |
当呼叫者发送重新 INVITE 或 UPDATE 请求时，媒体功能可在呼叫中途发生更改。当属性设置为 true 时，Voice Gateway 会使用文字 vgwMediaCapsChanged 启动面向 Watson Assistant 的新轮次，以指示成功更新了媒体功能。 |
SEND_ON_FIRST_TURN_TO_CONVERSATION |
无 | 包含需要在第一个轮次请求中发送到 Watson Assistant 服务的环境变量的逗号分隔列表。此环境变量用于通过发送 private.my_credentials.username 和 private.my_credentials.password 状态变量来设置 Cloud Function 用户名和密码。V1.0.0.6 和更高版本。 |
SIP_HOST |
无 | SIP 服务器正在其中进行侦听的 SIP Orchestrator Docker 容器的外部 IP。通常设置为 ${EXTERNAL_IP}。 |
SIP_PORT |
5060 |
用户数据报协议 (UDP) 的外部 SIP 端口。必须设置为与 SIP_PORT_TCP 环境变量相同的值。 |
SIP_PORT_TCP |
5060 |
传输控制协议 (TCP) 的外部 SIP 端口。必须设置为与 SIP_PORT 环境变量相同的值。 |
SIP_PORT_TLS |
5061 |
传输层安全性 (TLS) 的外部 SIP 端口。 |
USE_OPTIMAL_CONFIGURATION |
false |
指定是否对发行版使用最佳配置。当设置为 true 时，最佳配置设置用于 OPTIMAL_CONFIGURATION_VERSION 环境变量中定义的 Voice Gateway 版本。V1.0.0.6c 和更高版本。 |
OPTIMAL_CONFIGURATION_VERSION |
最新版本 | 指定要使用的最佳配置设置的 Voice Gateway 版本。例如，1.0.0.6c。V1.0.0.6.c 和更高版本。 |
JMS_PORT |
7276 |
消息传递引擎为接受入局请求而侦听的不受保护端口。消息传递引擎仅用于内部通信。仅当存在端口冲突时才更改缺省设置。V1.0.2.2 和更高版本。 |
JMS_PORT_SSL |
7286 |
消息传递引擎为接受入局请求而侦听的受保护端口。消息传递引擎仅用于内部通信。仅当存在端口冲突时才更改缺省设置。V1.0.2.2 和更高版本。 |
日志记录和跟踪配置
在故障诊断和支持中了解有关日志记录和跟踪的更多信息。
| 环境变量 | 缺省值 | 描述 |
|---|---|---|
LOG_LEVEL |
audit |
这是 SIP Orchestrator 的日志级别。有效值从最少信息到最多信息依次为 off、fatal、severe、warning、audit、fine、finest 和 all。请注意，当设置为 fine、finest 或 all 时，日志可能包含敏感的 PHI、PII 和 PCI DSS 数据。 |
LOG_MAX_FILES |
5 |
日志文件、跟踪文件和异常摘要日志文件的最大数量。当达到该限制时，将删除最旧的文件并创建新文件。例如，当该变量设置为 5 时，SIP Orchestrator 最多可生成 5 个消息日志，5 个跟踪日志和 5 个异常摘要。 |
LOG_MAX_FILE_SIZE |
100 |
创建新文件之前日志文件可达到的最大大小（以兆字节 (MB) 为单位）。 |
ENABLE_AUDIT_MESSAGES |
true |
设置 false 可禁用审计消息。 |
ENABLE_TRANSCRIPTION_AUDIT_MESSAGES |
false |
设置为 true 可启用审计转录消息。请注意，启用这些消息时，它们将输出到日志，而且可能包含敏感的 PHI、PII 和 PCI DSS 数据。 |
LATENCY_REPORTING_THRESHOLD |
1000 |
报告往返 Watson Assistant 等待时间的阈值（毫秒）。 |
RELAY_LATENCY_REPORTING_THRESHOLD |
1000 |
报告 Media Relay 相关等待时间的阈值（毫秒）。具体而言，当前支持 Text to Speech 等待时间报告。 |
WLP_SKIP_UMASK |
false |
当设置为 false时，服务器会将日志文件许可权设置为拒绝其他用户进行访问。设置为 true 可向其他用户授予读访问权。 |
安全性和代理配置
在保护 Voice Gateway 安全中了解有关配置安全性的更多信息。
| 环境变量 | 缺省值 | 描述 |
|---|---|---|
PROXY_HOST |
无 | 定义转发代理服务器的主机。 |
PROXY_PORT |
无 | 定义转发代理服务器的端口。 |
PROXY_USERNAME |
无 | 代理认证的用户名。V1.0.0.3 和更高版本。 |
PROXY_PASSWORD |
无 | 代理认证的密码。V1.0.0.3 和更高版本。 |
SSL_KEY_TRUST_STORE_FILE |
JVM 信任库 | 包含认证中心 (CA) 的可信证书的信任库文件的位置。在 V1.0.2 之前，同时充当信任库和密钥库。从 V1.0.2 开始，可以对信任库和密钥库使用不同的文件。 |
SSL_FILE_TYPE |
JKS | 信任库文件的文件类型。有效值为 JKS、JCEKS 和 PKCS12。 |
SSL_PASSPHRASE |
changeit | 用于保护信任库文件的口令。 |
SSL_KEY_STORE_FILE |
SSL_KEY_TRUST_STORE_FILE | 包含 Voice Gateway 证书（包括其专用密钥）的密钥库文件的位置。如果未配置，那么 SSL_KEY_TRUST_STORE_FILE 同时充当密钥库和信任库。V1.0.2 和更高版本。 |
SSL_KEY_PASSPHRASE |
SSL_PASSPHRASE | 用于保护密钥库文件的口令。V1.0.2 和更高版本。 |
SSL_KEY_FILE_TYPE |
SSL_FILE_TYPE | 密钥库文件的文件类型。有效值为 JKS、JCEKS 和 PKCS12。V1.0.2 和更高版本。 |
WHITELIST_FROM_URI |
无 | 可以在租户级别定义此配置。请参阅常规租户配置。 |
WHITELIST_TO_URI |
无 | 定义后，Voice Gateway 仅接受在 SIP To URI 中包含指定字符串（例如电话号码）的呼叫。在 V1.0.0.3 和更高版本中，如果在 To 头字段中找不到该字符串，那么 Voice Gateway 将搜索 Request-URI 值。 |
TRUSTED_IP_LIST |
无 | IP 地址的逗号分隔列表。定义后，Voice Gateway 仅接受来自指定 IP 地址的呼叫。将拒绝来自其他源的所有通信，包括所发送的用于监视 Voice Gateway 的呼叫和 OPTIONS 消息。V1.0.0.1 以及更新的版本。 |
WHITELIST_SIPREC_ATTR_NAME |
无 | 定义后，Voice Gateway 仅接受在 SIPREC 元数据中包含指定属性的呼叫。此属性值必须与 WHITELIST_SIPREC_ATTR_VALUE 环境变量中指定的值匹配。V1.0.2 和更高版本。 |
WHITELIST_SIPREC_ATTR_VALUE |
无 | 此环境变量在配置了 WHITELIST_SIPREC_ATTR_NAME 时是必需的。定义后，Voice Gateway 仅接受在 SIPREC 元数据中包含 WHITELIST_SIPREC_ATTR_NAME 中指定的属性且其值为此变量所指定值的呼叫。V1.0.2 和更高版本。 |
SIP 会话配置
通过以下某些环境变量，可以使用状态变量在 Voice Gateway 和 Watson Assistant 之间传递值。在自助服务代理程序的 API 中了解更多信息。
| 环境变量 | 缺省值 | 描述 |
|---|---|---|
ACCEPT_TRANSFER_REJECT_CODES |
无 | 当 Voice Gateway 在呼叫转接期间处理 NOTIFY 请求时作为成功响应处理的错误代码的逗号分隔列表。缺省情况下，[200-299] 中的所有代码都是成功响应。如果 NOTIFY 请求中的响应代码不是介于 [200-299] 之间，那么转接过程将失败。可以通过添加此配置属性来扩展成功响应的列表。V1.0.0.6 和更高版本。 |
CUSTOM_SIP_INVITE_HEADER |
无 | 要从入局 SIP INVITE 请求中抽取的 SIP 头字段。设置后，指定的 SIP 头的值传递到 vgwSIPCustomInviteHeader 状态变量中的 Watson Assistant。 |
CUSTOM_SIP_INVITE_HEADERS |
无 | 要从入局 SIP INVITE 请求中抽取的 SIP 头字段的逗号分隔列表。设置后，指定的 SIP 头的值传递到 vgwSIPCustomInviteHeaders 状态变量中的 Watson Assistant。 |
CUSTOM_SIP_SESSION_HEADER |
Call-ID |
其值用作全局会话标识的 SIP 头字段。指定的 SIP 头的值会在所有审计消息中使用，并且传递到 vgwSessionID 状态变量中的 Watson Assistant。 |
CUSTOM_SIPREC_SESSION_FIELD |
gcid |
其值用作全局会话标识的 SIPREC 元数据字段。指定的 SIPREC 元数据字段的值会在所有审计消息中使用，并且传递到 vgwSessionID 状态变量中的 Watson Assistant。如果在元数据中找不到已配置的字段，那么将使用 CUSTOM_SIP_SESSION_HEADER 环境变量来确定全局会话标识。定制 SIPREC 会话字段的可能值包括 gcid、callid 和 session_id。V1.0.0.6a 和更高版本。 |
POST_RESPONSE_TIMEOUT |
7000 | 向呼叫者回放响应之后等待新发声的时间（毫秒）。如果超过该值，那么 Watson Assistant 将接收到包含文字“vgwPostResponseTimeout”的文本更新，以指示发生了超时。 |
SESSION_INACTIVITY_TIMEOUT |
2 |
会话可以处于不活动状态的时间（分钟）。当超时到期时，Voice Gateway 将结束会话。 |
SEND_PROVISIONAL_RESPONSE |
true |
可以在租户级别定义此配置。请参阅常规租户配置。 |
SEND_SIP_CALL_ID_TO_CONVERSATION |
false |
当值为 true 时，SIP 呼叫标识将通过 vgwSIPCallID 状态变量传递到 Watson Assistant。 |
SEND_SIP_REQUEST_URI_TO_CONVERSATION |
false |
当值为 true 时，SIP 请求 URI 将通过 vgwSIPRequestURI 状态变量传递到 Watson Assistant。 |
SEND_SIP_TO_URI_TO_CONVERSATION |
false |
当值为 true 时，SIP To URI 将通过 vgwSIPToURI 状态变量传递到 Watson Assistant。 |
SEND_SIP_FROM_URI_TO_CONVERSATION |
false |
当值为 true 时，SIP From URI 将通过 vgwSIPFromURI 状态变量传递到 Watson Assistant。 |
CONVERSATION_FAILED_REPLY_MESSAGE |
由于技术问题，呼叫转接到代理程序。再见。 |
由于其中一个 Watson 服务发生故障而正在转接/断开呼叫时，流式传输给呼叫者的消息。 如果未配置默认目标，您可能希望更改默认消息。 |
CONVERSATION_FAILED_REPLY_AUDIO_URL |
无 | 在 Voice Gateway 尝试回放 CONVERSATION_FAILED_REPLY_MESSAGE 消息时无法访问 Text to Speech 服务的情况下播放的音频文件的 URL。 |
TRANSFER_DEFAULT_TARGET |
无 | 标识要转接到的目标端点。必须是有效的 SIP 或 tel URI（例如 sip:10.10.10.10）。仅当发生故障并且无法从 Watson Assistant API 获取呼叫转接目标时，才会使用此缺省转接目标。 |
TRANSFER_FAILED_REPLY_MESSAGE |
到代理程序的呼叫转接失败。请稍后再试。再见。 |
当 DISCONNECT_CALL_ON_TRANSFER_FAILURE 设置为 true 时，呼叫转接失败情况下以流式方法传送到呼叫者的消息。 |
TRANSFER_FAILED_REPLY_AUDIO_URL |
None |
在 Voice Gateway 尝试回放 TRANSFER_FAILED_REPLY_MESSAGE 消息时无法访问 Text to Speech 服务的情况下播放的音频文件的 URL。 |
DISCONNECT_CALL_ON_TRANSFER_FAILURE |
true |
确定在呼叫转接失败时是否将呼叫断开连接。当设置为 false 时，Voice Gateway 通过向 Watson Assistant 发送 "vgwCallTransferFailed" 文本来启动对话轮次。然后，Watson Assistant 可以断开呼叫连接或将其转接到对话中配置的其他目标。必须为 V1.0.0.2 和更高版本启用此环境变量。请参阅故障时转接。 |
PUT_CALLER_ON_HOLD_ON_TRANSFER |
true |
可以在租户级别定义此配置。请参阅常规租户配置。 |
CMR_HEALTH_CHECK_FAIL_ERR_CODE |
无 | 当 Voice Gateway 暂时不可用时要在 SIP OPTIONS 响应中发送的错误代码。缺省情况下，发生故障时将忽略 OPTION 消息。 |
租户配置
以下环境变量定义特定于租户的配置。仅针对面向 Docker 和 IBM Cloud Kubernetes Service 的单租户部署在部署配置中定义这些变量。对于使用 JSON 配置的部署或面向 IBM Cloud Private 的部署，改为在单独的 JSON 文件中定义租户配置。有关详细信息，请参阅在多租户 JSON 配置中配置租户。
常规租户配置
| 环境变量 | 缺省值 | 描述 |
|---|---|---|
DISABLE_STT_DURING_PLAYBACK |
false |
确定在回放音频时是否暂停所有语音转文字处理，从而在音频播放期间禁用语音打断。当设置为 true 时，Voice Gateway 会暂停语音转文字处理，然后再启动回放事务。当事务完成时，Voice Gateway 恢复语音转文字处理。有关更多信息，请参阅配置打断。V1.0.0.4c 和更高版本。 |
FINAL_UTTERANCE_TIMEOUT |
无 | Voice Gateway 等待从 Speech to Text 服务接收最终发声的时间（以毫秒为单位）。如果 Voice Gateway 在指定的时间限制内未收到最终发声，那么将发生超时，即使继续生成假设也如此。当超时发生时，Voice Gateway 会向 Watson Assistant 发送包含文字“vgwFinalUtteranceTimeout”的文本更新，以指示未收到任何最终发声。V1.0.0.4c 和更高版本。 |
PUT_CALLER_ON_HOLD_ON_TRANSFER |
true |
确定是否在转接呼叫时将呼叫者保持通话。如果启用此设置，那么某些服务提供商（例如 AT&T® 8YY 服务）会转接失败。如果呼叫锚点在转接期间将两条呼叫线路均保持通话，请将此变量设置为 false。V1.0.0.3 和更高版本。 |
SEND_PROVISIONAL_RESPONSE |
true |
确定 Voice Gateway 在处理入局呼叫时是否首先发送 180 Ringing 响应，然后再发送 200 OK 或错误响应。当设置为 false 时，Voice Gateway 不会发送 180 Ringing 响应，而只发送 200 OK 或错误响应。V1.0.0.3 和更高版本。 |
SEND_SIPREC_METADATA_TO_STT |
false |
可能的值是 true 和 false。如果设置为 true，那么会在建立会话时将 SIPREC 元数据发送到 STT。V1.0.3.0 和更高版本。 |
TENANT_TYPE |
agentAssist 表示代理程序助手和 SIPREC 会话，selfService 表示自助服务会话。 |
可能的值包括 agentAssist、selfService 和 continuousRecognition。租户类型设置为时 agentAssist 或 continuousRecognition 时，语音识别是在呼叫周期内开放，而不是在单次对话中开放。只要有针对 Watson Assistant 或 SOE 的现有传出请求，语音识别转录就会排队。 |
WHITELIST_FROM_URI |
无 | 定义后，Voice Gateway 仅接受在 SIP From URI 中包含指定字符串（例如电话号码）的呼叫。可在逗号分隔列表中定义多个字符串。 |
SMS Gateway 集成的 SMS 管道部署配置
| 环境变量 | 缺省值 | 描述 |
|---|---|---|
ENABLE_INBOUND_SMS |
False |
确定是否预期会收到来自呼叫者的入站 SMS 消息。设置为 True 或 False。当设置为 True 时，将创建 SMS 管道。否则，仅支持发送到呼叫者的出站 SMS 消息。可选。V1.0.0.6 和更高版本。 |
SMS_GW_URL |
无 | 要将请求发送到的 SMS Gateway 服务器 URL，如 https://SMShost:port/sms.gateway/smsPipe。例如，https://10.10.10.10:9043/sms.gateway/smsPipe V1.0.0.6 和更高版本。 |
SMS_GW_USERNAME |
无 | 用于认证的 SMS Gateway 服务器用户名。这必须设置为与 SMS Gateway 租户 controlCredentials 对象配置中的 username 相同的值。请参阅 controlCredentials 对象属性。V1.0.0.6 和更高版本。 |
SMS_GW_PASSWORD |
无 | 用于认证的 SMS Gateway 服务器密码。这需要是与 SMS Gateway 租户 controlCredentials 对象配置中的 password 所设置相同的值。请参阅 controlCredentials 对象属性。V1.0.0.6 和更高版本。 |
SMS_PIPE_EXPIRATION_INTERVAL |
1200 |
SMS 管道到期之前的时间间隔（以秒为单位）。缺省情况下设置为 1200 秒（20 分钟）。V1.0.0.6 和更高版本。 |
TENANT_PHONE_NUMBER |
无 | 可选。租户电话号码，如“+12222222222”。如果未定义并且在 smsActSendSMS 操作中未定义租户电话号码，那么 Voice Gateway 在缺省情况下使用已呼叫的租户电话号码。V1.0.0.6 和更高版本。 |
WEB_HOOK_HOST |
无 | SMS Gateway 发送 SMS 消息时所在的 Voice Gateway 服务器的 IP 地址或主机名。通常，这是与本地 Voice Gateway 服务器实例关联的节点 IP 地址。必须可从 SMS Gateway 实例访问此 IP 地址或主机名。V1.0.0.6 和更高版本。 |
SMS_GW_CONNECT_TIMEOUT |
5 |
Voice Gateway 等待与 SMS Gateway 建立套接字连接的时间（以秒为单位）。如果超过该时间，那么 Voice Gateway 将重新尝试与 SMS Gateway 进行连接。如果仍无法访问服务，那么 Voice Gateway 将通知 Conversation 服务，无法发送某个 SMS 消息。V1.0.0.6 和更高版本。 |
SMS_GW_READ_TIMEOUT |
5 |
Voice Gateway 等待来自 SMS Gateway 的响应的时间（以秒为单位）。如果超过该时间，那么 Voice Gateway 将重新尝试访问 SMS Gateway。如果仍无法访问服务，那么 Voice Gateway 将通知 Conversation 服务，无法发送某个 SMS 消息。V1.0.0.6 和更高版本。 |
Voice Gateway Web 接口配置
| 环境变量 | 缺省值 | 描述 |
|---|---|---|
HTTP_HOST |
localhost |
缺省情况下，HTTP_HOST 设置为 localhost 以保护 Web 接口并将访问仅限于本地主机。当需要允许入站 SMS 消息或 REST API 时，设置为 *，从而可从外部服务器访问 HTTP 接口。如果将 HTTP_HOST 设置为 *，那么可以通过设置 ADMIN_PASSWORD 和 ADMIN_USER 来保护 Web 接口，以便只有已配置并已认证的用户对其具有访问权。 |
HTTP_PORT |
9080 |
外部 HTTP 端口。V1.0.0.6 和更高版本。 |
HTTPS_PORT |
9443 |
外部 HTTPS 端口。V1.0.0.6 和更高版本。 |
ADMIN_USERNAME |
无 | 用于保护 HTTP_HOST 公开的 Web 接口的用户名。V1.0.0.6 和更高版本。 |
ADMIN_PASSWORD |
无 | 用于保护 HTTP_HOST 公开的 Web 接口的密码。V1.0.0.6 和更高版本。 |
报告事件配置
在报告事件中了解有关配置 Voice Gateway 以生成用于分析的报告事件的更多信息。
| 环境变量 | 缺省值 | 描述 |
|---|---|---|
REPORTING_URL |
无 | 接收事件的 Splunk HEC 服务器或 HTTP 服务器的主机名。 |
REPORTING_USERNAME |
无 | 用于基本认证的权限名称。对于 Splunk HEC，该值可以是任何字符串。 |
REPORTING_PASSWORD |
无 | 用于基本认证的权限密码。对于 Splunk HEC，将该值设置为 Splunk 生成的令牌。 |
REPORTING_CDR_EVENT_INDEX |
无 | 将事件标识为呼叫详情记录 (CDR) 的字符串，例如 cdr。指定值包含在所有 CDR 事件的索引字段中。必须定义该变量才能生成 CDR 事件。 |
REPORTING_CONVERSATION_EVENT_INDEX |
无 | 将事件标识为 Watson Assistant 轮次事件的字符串，例如 conv。指定值包含在所有 Watson Assistant 轮次事件的索引字段中。必须定义此变量才能生成 Watson Assistant 轮次事件。 |
REPORTING_CONVERSATION_REQUEST_EVENT_INDEX |
无 | 用于将事件标识为 Watson Assistant 轮次事件的字符串，例如 convRequest。配置后，将在向 Watson Assistant 发送轮次请求之前生成事件。指定的值包含在向 Watson Assistant 发送请求之前生成的所有 Watson Assistant 轮次事件的索引字段中。必须定义此变量才能在向 Watson Assistant 发送请求之前生成 Watson Assistant 轮次事件。 |
REPORTING_TRANSCRIPTION_EVENT_INDEX |
无 | 将事件标识为转录事件的字符串，例如 transcription。指定的值包含在所有转录事件的索引字段中。必须定义此变量才能生成转录事件。V1.0.0.2 和更高版本。 |
REPORTING_CDR_CLOUDANT_URL |
无 | IBM Cloudant 实例（用于存储 CDR 事件）托管所在的 URL。V1.0.0.5d 和更高版本。 |
REPORTING_CDR_CLOUDANT_ACCOUNT |
无 | 对于 CDR 事件报告，如果用户名和帐户名称不同，那么是指用于定义 IBM Cloudant 帐户名称的字符串。在 IBM Cloudant 中，用户名和帐户名称通常相同。V1.0.0.5d 和更高版本。 |
REPORTING_CDR_CLOUDANT_USERNAME |
无 | 对于 CDR 事件报告，是指与 IBM Cloudant 凭证关联的用户名。V1.0.0.5d 和更高版本。 |
REPORTING_CDR_CLOUDANT_PASSWORD |
无 | 对于 CDR 事件报告，是指与 IBM Cloudant 凭证关联的密码。V1.0.0.5d 和更高版本。 |
REPORTING_CDR_CLOUDANT_APIKEY |
无 | API 密钥 apikey，即 IBM Cloudant 服务的凭证。 使用 API 密钥配置 REPORTING_CDR_CLOUDANT_APIKEY 并将 REPORTING_CDR_CLOUDANT_URL 设置为 IBM Cloudant 服务 URL https://3a14b-15g9-67aa-bluemix.cloudant.com。否则，可以配置 REPORTING_CDR_CLOUDANT_USERNAME 和 REPORTING_CDR_CLOUDANT_PASSWORD。创建 IBM Cloudant 实例时，可以使用仅 IAM 选项或用户名/密码组合或 API 密钥选项来允许访问。有关 API 密钥的信息，请参阅 IBM Cloudant：API 密钥。V1.0.0.7
和更高版本。 |
REPORTING_CDR_CLOUDANT_DB_NAME |
无 | 用于存储 CDR 事件的 IBM Cloudant 数据库的名称。V1.0.0.5d 和更高版本。 |
REPORTING_CDR_CLOUDANT_EVENT_INDEX |
无 | 将事件标识为呼叫详情记录 (CDR) 的字符串，例如 cdr。指定的值包含在向 IBM Cloudant 数据库报告的所有 CDR 事件的索引字段中。必须定义此变量才能生成要在数据库中发布的 CDR 事件。V1.0.0.5d 和更高版本。 |
REPORTING_TRANSCRIPTION_CLOUDANT_ACCOUNT |
无 | 对于转录事件报告，如果用户名和帐户名称不同，那么是指用于定义 IBM Cloudant 帐户名称的字符串。在 IBM Cloudant 中，用户名和帐户名称通常相同。V1.0.0.6 和更高版本。 |
REPORTING_TRANSCRIPTION_CLOUDANT_URL |
无 | IBM Cloudant 实例（用于存储转录事件）托管所在的 URL。V1.0.0.5d 和更高版本。 |
REPORTING_TRANSCRIPTION_CLOUDANT_USERNAME |
无 | 对于转录事件报告，是指与 IBM Cloudant 凭证关联的用户名。V1.0.0.6 和更高版本。 |
REPORTING_TRANSCRIPTION_CLOUDANT_PASSWORD |
无 | 对于转录事件报告，是指与 IBM Cloudant 凭证关联的密码。V1.0.0.6 和更高版本。 |
REPORTING_TRANSCRIPTION_CLOUDANT_APIKEY |
无 | API 密钥 apikey，即 IBM Cloudant 服务的凭证。使用 API 密钥配置 REPORTING_TRANSCRIPTION_CLOUDANT_APIKEY 并将 REPORTING_TRANSCRIPTION_CLOUDANT_URL 设置为 IBM Cloudant 服务 URL https://3a14b-15g9-67aa-bluemix.cloudant.com。否则，可以配置
REPORTING_TRANSCRIPTION_CLOUDANT_USERNAME 和 REPORTING_TRANSCRIPTION_CLOUDANT_PASSWORD。创建 IBM Cloudant 实例时，可以使用仅 IAM 选项或用户名/密码组合或 API 密钥选项来允许访问。有关如何查找服务凭证的信息，请参阅 IBM Cloudant：API 密钥。V1.0.0.7
和更高版本。 |
REPORTING_TRANSCRIPTION_CLOUDANT_DB_NAME |
无 | 转录事件的 IBM Cloudant 数据库的名称。V1.0.0.6 和更高版本。 |
REPORTING_TRANSCRIPTION_CLOUDANT_EVENT_INDEX |
无 | 将事件标识为转录事件的字符串，例如 transcription。指定的值包含在向 IBM Cloudant 数据库报告的所有转录事件的索引字段中。必须定义此变量才能生成要在数据库中发布的转录事件。V1.0.0.6 和更高版本。 |
REPORTING_CONVERSATION_CLOUDANT_ACCOUNT |
无 | 对于 Watson Assistant 轮次事件报告，如果用户名和帐户名称不同，那么是指用于定义 IBM Cloudant 帐户名称的字符串。在 IBM Cloudant 中，用户名和帐户名称通常相同。V1.0.0.6 和更高版本。 |
REPORTING_CONVERSATION_CLOUDANT_URL |
无 | IBM Cloudant 实例（用于存储对话轮次事件）托管所在的 URL。V1.0.0.5d 和更高版本。 |
REPORTING_CONVERSATION_CLOUDANT_USERNAME |
无 | 对于 Watson Assistant 轮次事件报告，是指与 IBM Cloudant 凭证关联的用户名。V1.0.0.6 和更高版本。 |
REPORTING_CONVERSATION_CLOUDANT_PASSWORD |
无 | 对于 Watson Assistant 轮次事件报告，是指与 IBM Cloudant 凭证关联的密码。V1.0.0.6 和更高版本。 |
REPORTING_CONVERSATION_CLOUDANT_APIKEY |
无 | API 密钥 apikey，即 IBM Cloudant 服务的凭证。使用 API 密钥配置 REPORTING_CONVERSATION_CLOUDANT_APIKEY 并将 REPORTING_CONVERSATION_CLOUDANT_URL 设置为 IBM Cloudant 服务 URL https://3a14b-15g9-67aa-bluemix.cloudant.com。否则，可以配置
REPORTING_CONVERSATION_CLOUDANT_USERNAME 和 REPORTING_CONVERSATION_CLOUDANT_PASSWORD。创建 IBM Cloudant 实例时，可以使用仅 IAM 选项或用户名/密码组合或 API 密钥选项来允许访问。有关如何查找服务凭证的信息，请参阅 IBM Cloudant：API 密钥。V1.0.0.7
和更高版本。 |
REPORTING_CONVERSATION_CLOUDANT_DB_NAME |
无 | Watson Assistant 轮次事件的 IBM Cloudant 数据库的名称。V1.0.0.6 和更高版本。 |
REPORTING_CONVERSATION_CLOUDANT_EVENT_INDEX |
无 | 用于将事件标识为 Watson Assistant 轮次事件的字符串，例如 conversation。指定的值包含在向 IBM Cloudant 数据库报告的所有轮次事件的索引字段中。必须定义此变量才能生成要在数据库中发布的转录事件。V1.0.0.6 和更高版本。 |
REPORTING_MASK_CALLER_ID |
false |
指示是否屏蔽 CDR 和转录报告中的呼叫者标识。 |
Watson Assistant 服务和服务编排引擎配置
The IBM Watson™ Assistant 服务为自助服务代理程序提供核心人工智能。您可以集成服务编排引擎来扩展代理程序的功能，而不是直接连接到 Watson Assistant。在通过服务编排引擎进行连接中了解更多信息。
| 环境变量 | 缺省值 | 描述 |
|---|---|---|
WATSON_CONVERSATION_WORKSPACE_ID |
无 | Watson Assistant API 的工作空间标识。有关如何查找工作空间标识的信息，请参阅 Watson Assistant 文档中的开发应用程序。 |
WATSON_CONVERSATION_USERNAME |
无 | Watson Assistant 服务的 username 凭证。请注意，该值不是您的 IBM Cloud 用户名。关于如何查找服务凭证的信息，请参阅 Watson 服务的服务凭证。对于服务编排引擎，请使用此变量指定 SOE 的用户名（如果此服务需要认证）。 |
WATSON_CONVERSATION_PASSWORD |
无 | Watson Assistant 服务的 password 凭证。请注意，该值不是您的 IBM Cloud 密码。关于如何查找服务凭证的信息，请参阅 Watson 服务的服务凭证。对于服务编排引擎，请使用此变量指定 SOE 的密码（如果此服务需要认证）。 |
WATSON_CONVERSATION_URL |
无 | Watson Assistant 服务 API 的 url 凭证，例如 https://gateway.watsonplatform.net/conversatioNonepi 或 https://gateway.watsonplatform.net/assistant/api。关于如何查找服务凭证的信息，请参阅 Watson 服务的服务凭证。对于服务编排引擎，请使用此变量指定 SOE 的精确 URL。 |
WATSON_CONVERSATION_API_VERSION |
v1（如果配置了 WATSON_CONVERSATION_WORKSPACE_ID）。v2（如果配置了 WATSON_ASSISTANT_ID）。 |
要使用的 Watson Assistant API 版本。Voice Gateway 支持 Watson Assistant API V1 和 V2。仅 Voice Gateway V1.0.1 和更高版本中支持 V2。 |
WATSON_CONVERSATION_APIKEY |
无 | API 密钥 apikey，即 Watson Assistant 服务的凭证。关于如何查找服务凭证的信息，请参阅 Watson 服务的服务凭证。您可以通过使用 WATSON_CONVERSATION_APIKEY 并将 WATSON_CONVERSATION_TOKEN_SERVICE_PROVIDER_URL 设置为 https://iam.cloud.ibm.com/identity/token，或者通过配置 WATSON_CONVERSATION_USERNAME 和 WATSON_CONVERSATION_PASSWORD，以配置与 Watson 服务的连接。仅在 Sydney 区域中可用。V1.0.0.6a 和更高版本。 |
WATSON_CONVERSATION_READ_TIMEOUT |
5 |
Voice Gateway 等待来自 Watson Assistant 的响应的时间（以秒为单位）。如果超过该时间，那么 Voice Gateway 将重新尝试访问 Watson Assistant。如果仍无法访问服务，那么呼叫将失败。 |
WATSON_CONVERSATION_CONNECT_TIMEOUT |
5 |
Voice Gateway 等待与 Watson Assistant 建立套接字连接的时间（以秒为单位）。如果超过该时间，那么 Voice Gateway 将重新尝试与 Watson Assistant 进行连接。如果仍无法访问服务，那么呼叫将失败。V1.0.0.3 和更高版本。 |
WATSON_CONVERSATION_CONNECTION_KA_ENABLED |
true |
true 或 false。缺省情况下设置为 true。指定在每个请求或响应后与 Watson Assistant 服务的连接是保持打开还是关闭。注：不支持连接复用。在每个请求或响应后将关闭连接。启用保持活动后，可能会导致一些希望连接保持打开状态的 REST 服务器发生问题。可以通过将此环境变量设置为 false 来关闭保持活动。1.0.0.7a
和更高版本。 |
WATSON_CONVERSATION_TOKEN_AUTH_ENABLED |
false |
启用面向 Watson Assistant 服务的令牌认证。缺省值为 false，表示启用基本认证。请参阅为 Watson 服务启用令牌认证。V1.0.0.5a 和更高版本。 |
WATSON_CONVERSATION_TOKEN_SERVICE_PROVIDER_URL |
https://gateway.watsonplatform.net/authorizatioNonepi/v1/token |
将从中请求认证令牌的 URL。V1.0.0.5a 和更高版本。 |
WATSON_CONVERSATION_TOKEN_SERVICE_URL |
无 | 令牌请求中嵌入的服务 URL，例如 https://gateway.watsonplatform.net/conversatioNonepi 或 https://gateway.watsonplatform.net/assistant/api。V1.0.0.5a 和更高版本。如果启用了令牌认证，但是未定义 WATSON_CONVERSATION_TOKEN_SERVICE_URL，那么缺省情况下使用
WATSON_CONVERSATION_URL 的值。 |
WATSON_ASSISTANT_ID |
无 | Watson Assistant V2 API 的 Watson Assistant 标识。仅 Watson Assistant V2 API 会使用助理标识。V1.0.1 和更高版本 |
Watson Virtual Agent 配置
注：在 2018 年 6 月 19 日之后，无法创建新的 Watson Virtual Agent 实例。此服务已在 2019 年 3 月 19 日从 IBM Cloud 目录中移除。
| 环境变量 | 缺省值 | 描述 |
|---|---|---|
WATSON_VA_URL |
无 | Watson Virtual Agent API 的 url 凭证。V1.0.0.2 和更高版本。 |
WATSON_VA_BOT_ID |
无 | Watson Virtual Agent API 的 bot_id 凭证。V1.0.0.2 和更高版本。 |
WATSON_VA_CLIENT_ID |
无 | Watson Virtual Agent 的 API 调用的 X-IBM-Client-Id 头字段的认证密钥。V1.0.0.2 和更高版本。 |
WATSON_VA_CLIENT_SECRET |
无 | Watson Virtual Agent 的 API 调用的 X-IBM-Client-Secret 头字段的认证密钥。V1.0.0.2 和更高版本。 |
Media Relay 环境变量
下表列出可用于配置 Media Relay 的所有 Docker 环境变量。
核心部署配置
无论 Voice Gateway 托管的租户数量如何，以下环境变量在整个部署中都适用。对于单租户环境和多租户 JSON 配置，请在部署配置中定义这些变量。
常规部署配置
| 环境变量 | 缺省值 | 描述 |
|---|---|---|
MEDIA_RELAY_WS_HOST |
0.0.0.0 |
Media Relay 在其中侦听来自 SIP Orchestrator 的请求的 IP 地址或主机名。Media Relay 将绑定到位于该地址的 WebSocket 服务器。 |
MEDIA_RELAY_WS_PORT |
8080 |
SIP Orchestrator 用于打开 WebSockert 会话的端口。 |
RTP_UDP_PORT_RANGE |
'16384-16394' | UDP 的端口范围，设置为字符串。 |
SDP_ADDRESS |
localhost |
Answer SDP for SIP 中要使用的地址。 |
CLUSTER_WORKERS |
1 |
要衍生的集群工作程序的数量。设置为 0 时，将衍生的工作程序数量等于 CPU 数量减去 1。 |
MAX_SESSIONS |
0 |
Media Relay 在停止创建新媒体会话之前要处理的并行媒体会话的最大数量。如果该变量未定义，那么它将设置为在 RTP_UDP_PORT_RANGE 变量上定义的端口数。 |
WATSON_STT_STREAMING_FRAME_SIZE |
100 |
指定发送到 Speech to Text 服务的音频的帧大小（以毫秒为单位）。V1.0.0.5 和更高版本。 |
STT_TRACK_LATENCY |
false |
当设置为 true 时，Media Relay 使用能量检测来跟踪响应等待时间。等待时间是 Media Relay 在呼叫者语音中检测到无声到 Media Relay 从 Speech to Text 接收最终结果之间的耗用时间量（以毫秒为单位）。V1.0.0.8 和更高版本。 |
RTP_CODECS |
无 | Media Relay 在 RTP 会话期间支持的编码解码器的逗号分隔列表。例如，要仅使用 PCMU，请将其设置为 RTP_CODECS=PCMU。仅支持 PCMU、PCMA 和 G722。V1.0.0.6a 和更高版本。 |
EXTERNAL_AUDIO_TRANSFORMS |
无 | 指向将用于对呼叫的音频进行编码和解码的外部编码解码器服务的 websocket URL 的逗号分隔列表。例如，要连接到在端口 3500 上侦听的位于 localhost 上的编码解码器服务，请将其设置为 EXTERNAL_AUDIO_TRANSFORMS=ws://localhost:3500。有关更多信息，请参阅外部编码解码器服务。V1.0.3.0
和更高版本。 |
日志记录和跟踪配置
在故障诊断和支持中了解有关日志记录和跟踪的更多信息。
| 环境变量 | 缺省值 | 描述 |
|---|---|---|
MEDIA_RELAY_LOG_LEVEL |
INFO |
日志级别。 将日志级别设置为 INFO、DEBUG 或 TRACE。请注意，当设置为 DEBUG 或 TRACE 时，日志可能包含敏感的 PHI、PII 和 PCI DSS 数据。 |
MEDIA_RELAY_LOG_ROTATION_FILE_COUNT |
10 |
对于 Bunyan 日志记录模块要保持循环的 Media Relay 日志文件数量。 |
MEDIA_RELAY_LOG_ROTATION_PERIOD |
1d |
Bunyan 日志记录模块对日志文件进行循环的周期。缺省情况下，日志文件每隔 24 小时循环一次。 |
RTP_PACKET_LOSS_REPORTING_THRESHOLD |
1000 |
Media Relay 记录警告消息之前检测到的丢包数。V1.0.0.1 以及更新的版本。 |
记录配置
在记录呼叫音频中了解有关配置呼叫记录的更多信息。
| 环境变量 | 缺省值 | 描述 |
|---|---|---|
ENABLE_RECORDING |
false |
设置为 true 可启用 Media Relay 上的呼叫音频录制。请注意，录制内容可能包含敏感的 PHI、PII 和 PCI DSS 数据。 |
STEREO_RECORDING |
false |
设置为 true 可将呼叫音频录制到左声道和右声道。来自 Watson Text To Speech 服务器或呼叫中心代理程序的音频录制到左声道，来自呼叫者的音频录制到右声道。要禁用立体声录制，还必须将 ENABLE_RECORDING 设置为 true。V1.0.0.4 和更高版本。 |
RTCP 配置
在使用 RTCP 来监视 RTP 音频流中了解有关使用 RTP 控制协议 (RTCP) 监视 RTP 音频流的更多信息。
| 环境变量 | 缺省值 | 描述 |
|---|---|---|
ENABLE_RTCP |
false |
设置为 true 可启用 RTP 控制协议 (RTCP) 来监视 RTP 音频流。启用 RTCP 后，在呼叫详细记录 (CDR) 报告事件中将包含呼叫期间生成的警告和含有音频流统计信息的网络摘要。V1.0.0.5 和更高版本。 |
RTCP_MAX_JITTER_THRESHOLD |
30 |
触发警告之前在接收到的 RTP 包之间的最大抖动（以毫秒为单位）。如果超过此最大值，那么 Voice Gateway 将针对受影响的入站或出站音频流发出警告。V1.0.0.5 和更高版本。 |
RTCP_MAX_PACKET_LOSS_THRESHOLD |
5 |
触发警告之前的最大丢包百分比。如果超过此最大值，那么 Voice Gateway 将针对受影响的入站或出站音频流发出警告。V1.0.0.5 和更高版本。 |
安全性和代理配置
在保护 Voice Gateway 安全中了解有关配置安全性的更多信息。
| 环境变量 | 缺省值 | 描述 |
|---|---|---|
PROXY_TYPE |
http |
定义要用于代理连接的协议。 |
PROXY_HOST |
无 | 转发代理服务器的主机。 |
PROXY_PORT |
无 | 转发代理服务器的端口。 |
PROXY_USERNAME |
无 | 代理认证的用户名。 |
PROXY_PASSWORD |
无 | 代理认证的密码。 |
WATSON_STT_ENABLE_PROXY |
true |
指示是否通过已配置的路由来转到 Watson Speech to Text 服务的连接。V1.0.0.1a 以及更高版本。 |
WATSON_TTS_ENABLE_PROXY |
true |
指示是否通过已配置的路由来转到 Watson Text to Speech 服务的连接。V1.0.0.1a 以及更高版本。 |
MUSIC_ON_HOLD_ENABLE_PROXY |
false |
指示是否通过已配置的代理来路由与任何暂挂音乐或一次性音频 URL 的连接。V1.0.0.1a 以及更高版本。 |
SSL_CLIENT_PKCS12_FILE |
无 | 包含加密信息（例如专用密钥、证书和可信认证中心）的 PKCS #12 文件的位置。 |
SSL_CLIENT_PASSPHRASE |
无 | 用于保证 PKCS #12 文件安全的口令。 |
SSL_CLIENT_CA_CERTIFICATE_FILE |
无 | 包含可信认证中心和自签名证书的 PEM 文件的位置。 |
租户配置
以下环境变量定义特定于租户的配置。仅针对面向 Docker 和 IBM Cloud Kubernetes Service 的单租户部署在部署配置中定义这些变量。对于面向 IBM Cloud Private 的多租户 JSON 配置或部署，改为在单独的 JSON 文件中定义租户配置。有关详细信息，请参阅在多租户 JSON 配置中配置租户。
Watson Speech to Text 服务配置
| 环境变量 | 缺省值 | 描述 |
|---|---|---|
WATSON_STT_USERNAME |
无 | Watson Speech to Text 服务的 username 凭证。请注意，该值不是您的 IBM Cloud 用户名。关于如何查找服务凭证的信息，请参阅 Watson 服务的服务凭证。 |
WATSON_STT_PASSWORD |
无 | Watson Speech to Text 服务的 password 凭证。请注意，该值不是您的 IBM Cloud 密码。关于如何查找服务凭证的信息，请参阅 Watson 服务的服务凭证。 |
WATSON_STT_URL |
https://stream.watsonplatform.net/speech-to-text/api |
Watson Speech to Text 服务 API 的 url 凭证。关于如何查找服务凭证的信息，请参阅 Watson 服务的服务凭证。 |
WATSON_STT_TOKEN_AUTH_ENABLED |
false |
启用面向 Speech to Text 服务的令牌认证。缺省值为 false，表示启用基本认证。请参阅为 Watson 服务启用基于用户名和密码的令牌认证。V1.0.0.5a 和更高版本。 |
WATSON_STT_TOKEN_SERVICE_PROVIDER_URL |
https://stream.watsonplatform.net/authorizatioNonepi/v1/token |
将从中请求认证令牌的 URL。V1.0.0.5a 和更高版本。 |
WATSON_STT_TOKEN_SERVICE_URL |
https://stream.watsonplatform.net/speech-to-text/api |
这是嵌入在令牌请求中的服务 URL。V1.0.0.5a 和更高版本。 |
WATSON_STT_APIKEY |
无 | API 密钥 apikey，即 Speech to Text 服务的凭证。关于如何查找服务凭证的信息，请参阅 Watson 服务的服务凭证。可以通过使用 WATSON_STT_APIKEY 并将 WATSON_STT_TOKEN_SERVICE_PROVIDER_URL 设置为 https://iam.cloud.ibm.com/identity/token，或者通过配置 WATSON_STT_USERNAME 和 WATSON_STT_PASSWORD，以配置与 Watson 服务的连接。V1.0.0.6a 和更高版本。 |
WATSON_STT_MODEL |
en-US_NarrowbandModel |
Watson Speech to Text 模型。缺省情况下，仅支持窄带模型。缺省窄带模型最适合用于电话语音的脱机解码。要在 V1.0.0.4 和更高版本中使用宽带模型，请参阅启用宽带视频。 |
WATSON_STT_MODEL_VERSION |
无 | 要使用的 Speech to Text 模型的版本，例如 en-US_NarrowbandModel.v2017-11-15。仅当要使用模型的特定版本而不是最新版本时，才设置此变量。有关更多信息，请参阅基本模型版本。V1.0.0.4c 和更高版本。 |
WATSON_STT_OPTOUT |
无 | 设置为 true 可选择不保存通过 Watson 服务器上的 Speech to Text 服务传递的数据。 |
WATSON_STT_MAXALTERNATIVES |
无 | 要从 Speech to Text 服务返回的语音识别替代方法的数量。缺省情况下，将使用来自 Speech to Text 服务的值。 |
WATSON_STT_CONFIDENCE_SCORE_THRESHOLD |
0 |
来自 Speech to Text 服务的消息的置信度阈值。置信度分数低于阈值的消息将不会用作响应。缺省值 0 表示将使用所有响应。建议值为 0 到 1 之间的值。 |
WATSON_STT_MODEL_CUSTOMIZATION_ID |
无 | 用于设置定制语言模型以进行识别。不推荐使用 V1.0.1.0 和更高版本，请改用 WATSON_STT_LANGUAGE_CUSTOMIZATION_ID。 |
WATSON_STT_LANGUAGE_CUSTOMIZATION_ID None |
用于设置定制语言模型以进行识别。V1.0.1.0 和更高版本。 | |
WATSON_STT_PROFANITY_FILTER |
无 | 设置为 true 可过滤来自 Watson Speech to Text 服务的抄本上的不雅言辞。缺省情况下，将使用来自 Speech to Text 服务的值。 |
WATSON_STT_SMART_FORMATTING |
true |
指示在识别请求的最终抄本中，是否要将日期、时间、一系列数字、电话号码、货币金额和因特网地址转换为可读性更强的传统表示法。 |
WATSON_STT_CONNECTION_TIMEOUT |
5 |
Voice Gateway 等待与 Watson Speech to Text 服务建立套接字连接的时间（以秒为单位）。如果超过该时间，那么 Voice Gateway 将重新尝试与 Watson Speech to Text 服务进行连接。如果仍无法访问服务，那么呼叫将失败。V1.0.0.5 和更高版本。 |
WATSON_STT_REQUEST_TIMEOUT |
5 |
Voice Gateway 等待与 Watson Speech to Text 服务建立语音识别会话的时间（以秒为单位）。如果超过该时间，那么 Voice Gateway 将重新尝试与 Watson Speech to Text 服务进行连接。如果仍无法访问服务，那么呼叫将失败。V1.0.0.5 和更高版本。 |
WATSON_STT_DISABLE_FIRST_TURN_BARGE_IN |
false |
将此值设置为 true 可在第一轮对话时禁用语音打断。 V1.0.2.0 和更高版本。 |
BARGE_IN_RESUME |
false |
设置为 true 可在最终发声的置信度分数低于 WATSON_STT_CONFIDENCE_SCORE_THRESHOLD 变量指定的阈值情况下在打断后恢复回放音频。有关更多信息，请参阅配置打断。V1.0.0.5 和更高版本。 |
ECHO_SUPPRESSION |
false |
设置为 true 禁止由于回传 Text To Speech 合成而可能发生的 Speech to Text 的结果。V1.0.0.4c 和更高版本。 |
仅当要使用宽带模型时，才配置以下环境变量。有关更多信息，请参阅启用宽带音频。
| 环境变量 | 缺省值 | 描述 |
|---|---|---|
WATSON_STT_BAND_PREFERENCE |
narrowband |
定义在会话中协商音频编码解码器时首选哪个音频频带。设置为 broadband 会尽可能使用宽带音频。V1.0.0.4 和更高版本。 |
WATSON_STT_BROADBAND_MODEL |
无 | Speech to Text 模型。V1.0.0.4 和更高版本。 |
WATSON_STT_BROADBAND_MODEL_VERSION |
无 | 要使用的 Speech to Text 模型的版本，例如 en-US_BroadbandModel.v2017-11-15。仅当要使用模型的特定版本而不是最新版本时，才设置此变量。有关更多信息，请参阅基本模型版本。V1.0.0.4c 和更高版本。 |
WATSON_STT_BROADBAND_OPTOUT |
无 | 设置为 true 可选择不保存通过 Watson 服务器上的 Speech to Text 服务传递的数据。V1.0.0.4 和更高版本。 |
WATSON_STT_BROADBAND_MAXALTERNATIVES |
无 | 要从 Speech to Text 服务返回的语音识别替代方法的数量。缺省情况下，将使用来自 Speech to Text 服务的值。V1.0.0.4 和更高版本。 |
WATSON_STT_BROADBAND_MODEL_CUSTOMIZATION_ID |
无 | 用于设置定制语言模型以进行识别。V1.0.0.4 和更高版本。不推荐使用 V1.0.1.0 和更高版本，请改用 WATSON_STT_BROADBAND_LANGUAGE_CUSTOMIZATION_ID。 |
WATSON_STT_BROADBAND_LANGUAGE_CUSTOMIZATION_ID |
无 | 用于设置定制语言模型以进行识别。V1.0.1.0 和更高版本。 |
WATSON_STT_BROADBAND_PROFANITY_FILTER |
无 | 设置为 true 可过滤来自 Speech to Text 服务的抄本上的不雅言辞。缺省情况下，将使用来自 Speech to Text 服务的值。V1.0.0.4 和更高版本。 |
WATSON_STT_BROADBAND_SMART_FORMATTING |
无 | 指示在识别请求的最终抄本中，是否要将日期、时间、一系列数字、电话号码、货币金额和因特网地址转换为可读性更强的传统表示法。V1.0.0.4 和更高版本。 |
Watson Text to Speech 服务配置
| 环境变量 | 缺省值 | 描述 |
|---|---|---|
WATSON_TTS_USERNAME |
无 | Watson Text to Speech 服务的 username 凭证。请注意，该值不是您的 IBM Cloud 用户名。关于如何查找服务凭证的信息，请参阅 Watson 服务的服务凭证。 |
WATSON_TTS_PASSWORD |
无 | Watson Text to Speech 服务实例的 password 凭证。请注意，该值不是您的 IBM Cloud 密码。关于如何查找服务凭证的信息，请参阅 Watson 服务的服务凭证。 |
WATSON_TTS_URL |
https://stream.watsonplatform.net/text-to-speech/api |
Watson Text to Speech 服务 API的 url 凭证。关于如何查找服务凭证的信息，请参阅 Watson 服务的服务凭证。 |
WATSON_TTS_TOKEN_AUTH_ENABLED |
false |
启用面向 Text to Speech 服务的令牌认证。缺省值为 false，表示启用基本认证。请参阅为 Watson 服务启用基于用户名和密码的令牌认证。V1.0.0.5a 和更高版本。 |
WATSON_TTS_TOKEN_SERVICE_PROVIDER_URL |
https://stream.watsonplatform.net/authorizatioNonepi/v1/token |
从中请求令牌的 URL。V1.0.0.5a 和更高版本。 |
WATSON_TTS_TOKEN_SERVICE_URL |
https://stream.watsonplatform.net/text-to-speech/api |
这是嵌入在令牌请求中的服务 URL。V1.0.0.5a 和更高版本。 |
WATSON_TTS_APIKEY |
无 | API 密钥 apikey，即 Text to Speech 服务的凭证。关于如何查找服务凭证的信息，请参阅 Watson 服务的服务凭证。可以通过使用 WATSON_TTS_APIKEY 并将 WATSON_TTS_TOKEN_SERVICE_PROVIDER_URL 设置为 https://iam.cloud.ibm.com/identity/token，或者通过配置 WATSON_TTS_USERNAME 和 WATSON_TTS_PASSWORD，以配置与 Watson 服务的连接。V1.0.0.6a 和更高版本。 |
WATSON_TTS_VOICE |
en-US_AllisonVoice |
Text to Speech 服务使用的语言。 |
WATSON_TTS_OPTOUT |
无 | 设置为 true 可选择不保存通过 Watson 服务器上的 Text to Speech 服务传递的数据。要退出，Media Relay 会通过 HTTP Rest 调用将 X-Watson-Learning-Opt-Out 参数发送至服务。 |
WATSON_TTS_JITTER_BUFFER_DELAY |
200 |
从 Text to Speech 服务回放音频之前要缓冲的时间量（以毫秒为单位）。串流音频出现的任何抖动便是由于这种缓冲区造成的。 |
WATSON_TTS_MODEL_CUSTOMIZATION_ID |
无 | 用于设置定制语音模型以供将文字转换为语音 (Text to Speech)。 |
WATSON_TTS_CONNECTION_TIMEOUT |
5 |
Voice Gateway 等待与 Watson Text to Speech 服务建立套接字连接的时间（以秒为单位）。如果超过该时间，那么 Voice Gateway 将重新尝试与 Watson Text to Speech 服务进行连接。如果仍无法访问服务，那么呼叫将失败。V1.0.0.5 和更高版本。 |
WATSON_TTS_REQUEST_TIMEOUT |
5 |
Voice Gateway 等待与 Watson Text to Speech 服务建立语音合成会话的时间（以秒为单位）。如果超过该时间，那么 Voice Gateway 将重新尝试与 Watson Text to Speech 服务进行连接。如果仍无法访问服务，那么呼叫将失败。V1.0.0.5 和更高版本。 |
TTS_CACHE_TIME_TO_LIVE |
0 |
对来自 Text to Speech 服务的响应进行高速缓存（以改善回放响应时间）的时间（以小时为单位）。启用后，除非通过设置 vgwExcludeFromTTSCache API 状态变量在 Watson Assistant 对话中排除了所有 Text to Speech 响应，否则将对这些响应进行高速缓存。请注意，除非您显式地从高速缓存排除包含敏感 PHI、PII 和 PCI DSS 数据的响应，否则将对这些响应进行高速缓存。缺省值
0 表示不对响应进行高速缓存。V1.0.0.1 以及更新的版本。 |
Speech to Text Adapter 环境变量
常规部署配置
下表列出可用于配置 Speech to Text Adapter 容器的环境变量：
| 环境变量 | 缺省值 | 描述 |
|---|---|---|
PORT |
4000 | 用于侦听来自 Media Relay 的请求的端口。 |
LOG_LEVEL |
debug |
Speech to Text Adapter 的日志级别。将日志级别设置为 info、debug 或 trace。请注意，当设置为 debug 或 trace 时，日志可能包含敏感的 PHI、PII 和 PCI DSS 数据。 |
GOOGLE_APPLICATION_CREDENTIALS |
无 | 与 Google Cloud 项目相关的服务帐户凭证的路径。此文件必须安装在 stt.adapter 容器中的卷上。 |
GOOGLE_SPEECH_RECOGNITION_CONFIG |
无 | 用于定义 Google Cloud Speech RecognitionConfig API 的值的 JSON 文件的路径。 |
GOOGLE_SPEECH_LANGUAGE_CODE |
en-US |
将来自呼叫者的音频的预期语言设置为 BCP-47 语言标记，例如 en-US。此变量类似于 Cloud Speech RecognitionConfig API 的 language_code 字段。请注意，为使自助服务代理程序以某种语言形式完全可运作，该语言还必须受到与 Voice Gateway 集成的其他服务的支持。请参阅受支持的语言以获取详细信息。 |
GOOGLE_SPEECH_MAX_ALTERNATIVES |
无 | 要从 Google Cloud Speech API 返回的语音识别替代方法的数量。此变量类似于 Cloud Speech RecognitionConfig API 的 max_alternatives 字段。 |
GOOGLE_SPEECH_PROFANITY_FILTER |
无 | 设置为 true 可过滤来自 Google Cloud Speech API 的抄本上的不雅言辞。此变量类似于 Cloud Speech RecognitionConfig API 的 profanity_filter 字段。 |
安全性和代理配置
在保护 Voice Gateway 安全中了解有关配置安全性的更多信息。
| 环境变量 | 缺省值 | 描述 |
|---|---|---|
STT_ADAPTER_USERNAME |
无 | 用于在 Speech To Text Adapter 上对来自 Voice Gateway 的连接启用基本认证的用户名。 |
STT_ADAPTER_PASSWORD |
无 | 用于在 Speech To Text Adapter 上对来自 Voice Gateway 的连接进行基本认证的密码。 |
PROXY_TYPE |
http |
定义用于代理连接的协议，即 http 或 https。 |
PROXY_HOST |
无 | 转发代理服务器的主机。 |
PROXY_PORT |
无 | 转发代理服务器的端口。 |
PROXY_USERNAME |
无 | 代理认证的用户名。 |
PROXY_PASSWORD |
无 | 代理认证的密码。 |
SSL_SERVER_PKCS12_FILE |
无 | 包含加密信息（例如专用密钥、证书和可信认证中心）的 PKCS #12 文件的位置。指定此环境变量可保护来自 Media Relay 的连接安全。 |
SSL_SERVER_PASSPHRASE |
无 | 用于保证 PKCS #12 文件安全的口令。 |
Text to Speech Adapter 环境变量
常规部署配置
下表列出可用于配置 Text to Speech Adapter 容器的环境变量：
| 环境变量 | 缺省值 | 描述 |
|---|---|---|
PORT |
4000 | 用于侦听来自 Media Relay 的请求的端口。 |
LOG_LEVEL |
debug |
Text To Speech Adapter 的日志级别。将日志级别设置为 info、debug 或 trace。请注意，当设置为 debug 或 trace 时，日志可能包含敏感的 PHI、PII 和 PCI DSS 数据。 |
GOOGLE_APPLICATION_CREDENTIALS |
无 | 与 Google Cloud 项目相关的服务帐户凭证的路径。此文件必须安装在 tts.adapter 容器中的卷上。 |
GOOGLE_TTS_VOICE_LANGUAGE_CODE |
en-US |
将语音的预期语言设置为 BCP-47 语言标记，例如 en-US。此变量类似于 Cloud Text-To-Speech VoiceSelectionParams API 的 language_code 字段。请注意，为使自助服务代理程序以某种语言形式完全可运作，该语言还必须受到与 Voice Gateway 集成的其他服务的支持。请参阅受支持的语言以获取详细信息。 |
GOOGLE_TTS_VOICE_NAME |
无 | 语音的名称。此变量类似于 Cloud Text-To-Speech VoiceSelectionParams 的 name 字段。 |
GOOGLE_TTS_VOICE_SSML_GENDER |
无 | 语音的首选性别。此变量类似于 Cloud Text-To-Speech VoiceSelectionParams 的 ssml_gender 字段。 |
GOOGLE_TTS_AUDIO_CONFIG_SPEAKING_RATE |
无 | 可选语速/速度。此变量类似于 Cloud Text-To-Speech AudioConfig 的 speaking_rate 字段。 |
GOOGLE_TTS_AUDIO_CONFIG_PITCH |
无 | 可选语调。此变量类似于 Cloud Text-To-Speech AudioConfig 的 pitch 字段。 |
GOOGLE_TTS_AUDIO_GAIN_DB |
无 | 可选：特定语音支持的正常自然音量的音量增益（以分贝为单位）。此变量类似于 Cloud Text-To-Speech AudioConfig 的 volume_gain_db 字段。 |
安全性和代理配置
在保护 Voice Gateway 安全中了解有关配置安全性的更多信息。
| 环境变量 | 缺省值 | 描述 |
|---|---|---|
TTS_ADAPTER_USERNAME |
无 | 用于在 Text To Speech Adapter 上对来自 Voice Gateway 的连接启用基本认证的用户名。 |
TTS_ADAPTER_PASSWORD |
无 | 用于在 Text To Speech Adapter 上对来自 Voice Gateway 的连接进行基本认证的密码。 |
PROXY_TYPE |
http |
定义用于代理连接的协议，即 http 或 https。 |
PROXY_HOST |
无 | 转发代理服务器的主机。 |
PROXY_PORT |
无 | 转发代理服务器的端口。 |
PROXY_USERNAME |
无 | 代理认证的用户名。 |
PROXY_PASSWORD |
无 | 代理认证的密码。 |
SSL_SERVER_PKCS12_FILE |
无 | 包含加密信息（例如专用密钥、证书和可信认证中心）的 PKCS #12 文件的位置。指定此环境变量可保护来自 Media Relay 的连接安全。 |
SSL_SERVER_PASSPHRASE |
无 | 用于保证 PKCS #12 文件安全的口令。 |
出站呼叫环境变量
下表列出可用于配置出站呼叫的环境变量：
| 环境变量 | 缺省值 | 描述 |
|---|---|---|
REST_API_USERNAME |
无 | 可选。用于 REST API 呼叫认证的用户名。V1.0.2 和更高版本。 |
REST_API_PASSWORD |
无 | 可选。用于 REST API 呼叫认证的密码。V1.0.2 和更高版本。 |
OUTBOUND_CALLS_TENANT_URI |
无 | 可选。租户 SIP/Tel URI。在出站呼叫的 From 头字段中设置，以防未通过 REST API 提供相应的字段。V1.0.2 和更高版本。 |
ENABLE_OUTBOUND_CALLS |
False | 可选。True/False。启用或禁用出站呼叫功能。 设置为“False”时，将拒绝 REST API 调用，并且错误响应为 403。 V1.0.2 和更高版本。 |
OUTBOUND_CALLS_STATUS_WEBHOOK |
无 | 可选。用于异步通知的 HTTP/HTTPS URL。V1.0.2 和更高版本。 |
OUTBOUND_CALLS_STATUS_WEBHOOK_USERNAME |
无 | 可选。向 Webhook 发送通知时用于认证的用户名。 V1.0.2 和更高版本。 |
OUTBOUND_CALLS_STATUS_WEBHOOK_PASSWORD |
无 | 可选。向 Webhook 发送通知时用于认证的密码。 V1.0.2 和更高版本。 |
OUTBOUND_CALLS_STATUS_WEBHOOK_CONNECT_TIMEOUT |
5 | 可选。Voice Gateway 等待与 WEB hook 建立套接字连接的时间（秒）。如果超过该时间，那么 Voice Gateway 将尝试重新连接。V1.0.2 和更高版本。 |
OUTBOUND_CALLS_STATUS_WEBHOOK_READ_TIMEOUT |
5 | 可选。Voice Gateway 等待来自 WEB hook 的响应的时间（秒）。如果超过该时间，那么 Voice Gateway 将尝试重新连接。V1.0.2 和更高版本。 |
OUTBOUND_CALLS_STATUS_WEBHOOK_MAX_RETRY_NUM |
2 | 可选。Voice Gateway 由于连接失败而尝试与 WEB hook 进行连接的最大次数。V1.0.2 和更高版本。 |
监视 REST API 环境变量
下表列出可用于配置监视的环境变量：
| 环境变量 | 缺省值 | 描述 |
|---|---|---|
| METRICS_SAMPLING_INTERVAL | 600 | 可选。更新度量的时间间隔（以秒为单位）。V1.0.2 和更高版本。 |
| ENABLE_METRICS_AUTH | false |
可选。指示是否为监视端点启用认证。当设置为 true 时，端点使用凭证进行保护。使用 ADMIN_USERNAME 和 ADMIN_PASSWORD 环境变量可配置用于认证的用户名和密码。V1.0.2 和更高版本。 |