Voice Gateway 的配置環境變數
您可以定義 Docker 環境變數，來配置 IBM® Voice Gateway。要在何處指定環境變數，取決於您 Voice Gateway 的部署所在：
- Docker 引擎：在您第一次將 Voice Gateway 部署在 Docker 引擎上時所建立的
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 Socket 會連結至這個主機名稱。通常設為 Media Relay 服務名稱（例如 vgw.media.relay:8080）。 |
MULTI_TENANT_CONFIG_FILE |
無 | 用來配置多租戶 JSON 配置之 JSON 檔案的路徑。1.0.0.2 版及更新版本。 |
NOTIFY_CONVERSATION_ON_FILTERED_UTTERANCES |
false |
將內容設為 true 時，Voice Gateway 會使用 "vgwSTTResultFiltered" 單字（指出因信任層次偏低，已過濾話語），對 Watson Assistant 起始新一回的交談。1.0.2 版及更新版本。 |
NOTIFY_CONVERSATION_ON_NETWORK_EVENTS |
false |
當設為 true，且偵測到網路錯誤時，Voice Gateway 會透過 "vgwNetworkWarningMessage" 文字，起始與 Watson Assistant 服務的一回交談。vgwNetworkWarnings 狀態變數含有在本回交談期間所發生的網路事件清單。如果旗標設為 false，則在本回交談期間發生的網路事件清單，會放到 vgwNetworkWarnings 狀態變數中的下回交談事件中傳送。1.0.0.5 版及更新版本。 |
NOTIFY_CONVERSATION_ON_MEDIA_CHANGE |
false |
當發話端傳送 re-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 使用者名稱和密碼。1.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 版本的最佳配置設定。1.0.0.6c 版及更新版本。 |
OPTIMAL_CONFIGURATION_VERSION |
最新的版本 | 指定要使用之最佳配置設定的 Voice Gateway 版本。例如 1.0.0.6c。1.0.0.6.c 版及更新版本。 |
JMS_PORT |
7276 |
非安全埠，供傳訊引擎用來接聽以接受送入的要求。傳訊引擎只用來進行內部通訊。請只在發生埠衝突時，才變更預設值。1.0.2.2 版及更新版本。 |
JMS_PORT_SSL |
7286 |
此安全埠可供傳訊引擎用來接聽以接受送入的要求。傳訊引擎只用來進行內部通訊。請只在發生埠衝突時，才變更預設值。1.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，可提供其他使用者讀取權。 |
安全和 Proxy 配置
如需進一步瞭解如何配置安全，請參閱維護 Voice Gateway 的安全。
| 環境變數 | 預設值 | 說明 |
|---|---|---|
PROXY_HOST |
無 | 定義轉遞 Proxy 伺服器的主機。 |
PROXY_PORT |
無 | 定義轉遞 Proxy 伺服器的埠。 |
PROXY_USERNAME |
無 | Proxy 鑑別用的使用者名稱。1.0.0.3 版及更新版本。 |
PROXY_PASSWORD |
無 | Proxy 鑑別用的密碼。1.0.0.3 版及更新版本。 |
SSL_KEY_TRUST_STORE_FILE |
JVM 信任儲存庫 | 含有憑證管理中心 (CA) 授信憑證之信任儲存庫檔案的位置。在 1.0.2 版以前，同時充當了信任儲存庫和金鑰儲存庫。從 1.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 充當金鑰儲存庫和信任儲存庫。1.0.2 版及更新版本。 |
SSL_KEY_PASSPHRASE |
SSL_PASSPHRASE | 用來維護金鑰儲存庫檔案安全的通行詞組。1.0.2 版及更新版本。 |
SSL_KEY_FILE_TYPE |
SSL_FILE_TYPE | 金鑰儲存庫檔的檔案類型。有效值為 JKS、JCEKS 和 PKCS12。1.0.2 版及更新版本。 |
WHITELIST_FROM_URI |
無 | 可在租戶層次定義這項配置。請參閱一般租戶配置。 |
WHITELIST_TO_URI |
無 | 若有定義此項，Voice Gateway 只接受含有 SIP To URI 內之指定字串（例如：電話號碼）的通話。在 1.0.0.3 版及更新版本中，如果在 To 標頭欄位中找不到字串，Voice Gateway 會搜尋 Request-URI 值。 |
TRUSTED_IP_LIST |
無 | 以逗點區隔的 IP 位址清單。若有定義此項，Voice Gateway 只接受來自指定 IP 位址的通話。其他來源的所有通訊會遭到拒絕，包括通話及為了監視 Voice Gateway 而傳送的 OPTIONS 訊息。1.0.0.1 版及更新版本。 |
WHITELIST_SIPREC_ATTR_NAME |
無 | 若有定義此項，Voice Gateway 只接受含有 SIPREC meta 資料中之指定屬性的通話。屬性值必須符合 WHITELIST_SIPREC_ATTR_VALUE 環境變數中指定的值。1.0.2 版及更新版本。 |
WHITELIST_SIPREC_ATTR_VALUE |
無 | 若有配置 WHITELIST_SIPREC_ATTR_NAME，則這個環境變數是必要的。若有定義此項，Voice Gateway 只接受含有 WHITELIST_SIPREC_ATTR_NAME 中指定之屬性的通話，且該屬性必須具有這個變數在 SIPREC meta 資料中所指定的值。1.0.2 版及更新版本。 |
SIP 階段作業配置
下列一些環境變數可讓值透過狀態變數，在 Voice Gateway 與 Watson Assistant 之間傳遞。如需進一步瞭解，請參閱自助式代理程式的 API。
| 環境變數 | 預設值 | 說明 |
|---|---|---|
ACCEPT_TRANSFER_REJECT_CODES |
無 | 在通話轉接期間，當 Voice Gateway 處理 NOTIFY 要求時，要視為成功回應的錯誤碼清單（以逗點區隔）。依預設，[200-299] 中的所有代碼都會視為成功回應。如果 NOTIFY 要求中的回應碼不在 [200-299] 之間，則轉接程序失敗。您可以新增這個配置屬性，來擴充成功回應清單。1.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 標頭欄位，會以其值作為廣域階段作業 ID。將指定 SIP 標頭的值用於所有審核訊息，並放在 vgwSessionID 狀態變數中傳遞給 Watson Assistant。 |
CUSTOM_SIPREC_SESSION_FIELD |
gcid |
SIPREC meta 資料欄位，會以其值作為廣域階段作業 ID。指定 SIPREC meta 資料欄位的值會用於所有審核訊息，並放在 vgwSessionID 狀態變數中傳遞給 Watson Assistant。如果在 meta 資料中找不到所配置的欄位，會使用 CUSTOM_SIP_SESSION_HEADER 環境變數來判定廣域階段作業 ID。自訂 SIPREC 階段作業欄位的可能值包括 gcid、callid 和 session_id。1.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，會在 vgwSIPCallID 狀態變數中，將 SIP 通話 ID 傳遞給 Watson Assistant。 |
SEND_SIP_REQUEST_URI_TO_CONVERSATION |
false |
若為 true，會在 vgwSIPRequestURI 狀態變數中，將 SIP 要求 URI 傳遞給 Watson Assistant。 |
SEND_SIP_TO_URI_TO_CONVERSATION |
false |
若為 true，會在 vgwSIPToURI 狀態變數中，將 SIP 目標 URI 傳遞給 Watson Assistant。 |
SEND_SIP_FROM_URI_TO_CONVERSATION |
false |
若為 true，會在 vgwSIPFromURI 狀態變數中，將 SIP 來源 URI 傳遞給 Watson Assistant。 |
CONVERSATION_FAILED_REPLY_MESSAGE |
因技術問題，正在轉接通話給代理程式。再見。 |
當因其中一項 Watson 服務失敗，而正在轉接或切斷通話時，將以串流方式傳送給發話端的訊息。如果未配置預設目標，您可能會想變更預設訊息。 |
CONVERSATION_FAILED_REPLY_AUDIO_URL |
無 | 音訊檔的 URL，在 Voice Gateway 嘗試播放 CONVERSATION_FAILED_REPLY_MESSAGE 訊息時，如果無法聯絡 Text to Speech 服務，就會播放此音訊檔。 |
TRANSFER_DEFAULT_TARGET |
無 | 識別指向端點的目標轉接。必須是有效的 SIP 或 tel URI（例如 sip：10.10.10.10）。只有在發生失敗，且無法從 Watson Assistant API 取得通話轉接目標時，才會使用這個預設轉接目標。 |
TRANSFER_FAILED_REPLY_MESSAGE |
將通話轉接至代理程式失敗。Please try again later. 再見。 |
當 DISCONNECT_CALL_ON_TRANSFER_FAILURE 設為 true 時，一旦通話轉接失敗，將以串流方式傳送給發話端的訊息。 |
TRANSFER_FAILED_REPLY_AUDIO_URL |
None |
音訊檔的 URL，在 Voice Gateway 嘗試播放 TRANSFER_FAILED_REPLY_MESSAGE 訊息時，如果無法聯絡 Text to Speech 服務，就會播放此音訊檔。 |
DISCONNECT_CALL_ON_TRANSFER_FAILURE |
true |
決定當通話轉接失敗時，是否要切斷通話。當設為 false 時，Voice Gateway 會將 "vgwCallTransferFailed" 文字傳送給 Watson Assistant，以起始一回交談。然後，Watson Assistant 可以中斷通話，或將它轉接至對話中所配置的不同目的地。若為 1.0.0.2 版及更新版本，則必須啟用。請參閱失敗時轉接。 |
PUT_CALLER_ON_HOLD_ON_TRANSFER |
true |
可在租戶層次定義這項配置。請參閱一般租戶配置。 |
CMR_HEALTH_CHECK_FAIL_ERR_CODE |
無 | 當 Voice Gateway 暫時無法使用時，要放在 SIP OPTIONS 回應中傳送的錯誤碼。依預設，當發生失敗時，會忽略 OPTIONS 訊息。 |
租戶配置
下列環境變數是定義租戶特定的配置。只針對 Docker 和 IBM Cloud Kubernetes Service 的單租戶部署，在部署配置中定義這些變數。若為使用 JSON 配置的部署或是 IBM Cloud Private 部署，請改以在個別的 JSON 檔案中定義租戶配置。如需詳細資訊，請參閱在多租戶 JSON 配置中配置租戶。
一般租戶配置
| 環境變數 | 預設值 | 說明 |
|---|---|---|
DISABLE_STT_DURING_PLAYBACK |
false |
決定在播放音訊期間，是否暫停所有的語音轉文字處理程序，這會在播放音訊期間停用語音打斷。當設為 true 時，Voice Gateway 在啟動播放交易之前，會先暫停語音轉文字處理程序。當交易完成時，Voice Gateway 會回復語音轉文字處理程序。如需相關資訊，請參閱配置打斷。1.0.0.4c 版及更新版本。 |
FINAL_UTTERANCE_TIMEOUT |
無 | Voice Gateway 等待接收來自 Speech to Text 服務之最終話語的時間（毫秒）。如果 Voice Gateway 在指定的時限內沒有收到最終話語，發生逾時（即使仍會繼續產生假設也一樣）。一旦發生逾時，Voice Gateway 會傳送含有 "vgwFinalUtteranceTimeout" 單字的文字更新給 Watson Assistant，指出未收到任何最話。1.0.0.4c 版及更新版本。 |
PUT_CALLER_ON_HOLD_ON_TRANSFER |
true |
決定在轉接通話期間，是否讓發話端維持通話。如果啟用這項設定，有些服務提供者（例如 AT&T® 8YY 服務）會讓轉接失敗。在轉接期間，如果通話錨點會讓雙方維持通話，請將這個變數設為 false。1.0.0.3 版及更新版本。 |
SEND_PROVISIONAL_RESPONSE |
true |
決定 Voice Gateway 在處理撥進的通話期間，是否要在傳送 200 OK 或錯誤回應之前，先傳送 180 Ringing 回應。當設為 false 時，Voice Gateway 不會傳送 180 Ringing 回應，只會傳送 200 OK 或錯誤回應。1.0.0.3 版及更新版本。 |
SEND_SIPREC_METADATA_TO_STT |
false |
可能的值為 true 及 false。如果設為 true，則在建立階段作業時，會將 SIPREC meta 資料傳送至 STT。1.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 訊息。選用。1.0.0.6 版及更新版本。 |
SMS_GW_URL |
無 | 要將要求送往的 SMS Gateway 伺服器 URL，例如 https://SMShost:port/sms.gateway/smsPipe。例如 https://10.10.10.10:9043/sms.gateway/smsPipe。1.0.0.6 版及更新版本。 |
SMS_GW_USERNAME |
無 | 鑑別用的 SMS Gateway 伺服器使用者名稱。所設定的值需要與 SMS Gateway 租戶 controlCredentials 物件配置中的 username 相同。請參閱 controlCredentials 物件的內容。1.0.0.6 版及更新版本。 |
SMS_GW_PASSWORD |
無 | 鑑別用的 SMS Gateway 伺服器密碼。需要與 SMS Gateway 租戶 controlCredentials 物件配置中之 password 所設定的值相同。請參閱 controlCredentials 物件的內容。1.0.0.6 版及更新版本。 |
SMS_PIPE_EXPIRATION_INTERVAL |
1200 |
SMS 管道每隔多少秒數之後就會到期。依預設，會設為 1200 秒（20 分鐘）。1.0.0.6 版及更新版本。 |
TENANT_PHONE_NUMBER |
無 | 選用。租戶電話號碼，例如 "+12222222222"。如果未定義，且租戶電話號碼未定義在 smsActSendSMS 動作中，則依預設，Voice Gateway 會使用所撥打的租戶電話號碼。1.0.0.6 版及更新版本。 |
WEB_HOOK_HOST |
無 | SMS Gateway 傳送 SMS 訊息時所在之 Voice Gateway 伺服器的 IP 位址或主機名稱。一般而言，這是本端 Voice Gateway 伺服器實例相關聯的節點 IP 位址。這個 IP 位址或主機名稱必須可從您的 SMS Gateway 實例來存取。1.0.0.6 版及更新版本。 |
SMS_GW_CONNECT_TIMEOUT |
5 |
Voice Gateway 在與 SMS Gateway 建立 Socket 連線時，要等待的時間（秒）。如果超過時間，Voice Gateway 會重新嘗試連接 SMS Gateway。如果仍無法呼叫到服務，Voice Gateway 會通知交談服務，指出無法傳送 SMS 訊息。1.0.0.6 版及更新版本。 |
SMS_GW_READ_TIMEOUT |
5 |
Voice Gateway 等待 SMS Gateway 回應的時間（秒）。如果超過時間，Voice Gateway 會重新嘗試連接 SMS Gateway。如果仍無法呼叫到服務，Voice Gateway 會通知交談服務，指出無法傳送 SMS 訊息。1.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 埠。1.0.0.6 版及更新版本。 |
HTTPS_PORT |
9443 |
外部 HTTPS 埠。1.0.0.6 版及更新版本。 |
ADMIN_USERNAME |
無 | 用來保護 HTTP_HOST 所顯露之 Web 介面的使用者名稱。1.0.0.6 版及更新版本。 |
ADMIN_PASSWORD |
無 | 用來保護 HTTP_HOST 所顯露之 Web 介面的密碼。1.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。指定的值會包含在所有轉錄事件的索引欄位中。必須定義此變數，才會產生轉錄事件。1.0.0.2 版及更新版本。 |
REPORTING_CDR_CLOUDANT_URL |
無 | 管理您 IBM Cloudant 實例（用來儲存 CDR 事件）所在的 URL。1.0.0.5d 版及更新版本。 |
REPORTING_CDR_CLOUDANT_ACCOUNT |
無 | 以 CDR 事件報告來說，此字串用來定義 IBM Cloudant 帳戶名稱（如果使用者名稱和帳戶名稱不同的話）。在 IBM Cloudant 中，使用者名稱和帳戶名稱通常相同。1.0.0.5d 版及更新版本。 |
REPORTING_CDR_CLOUDANT_USERNAME |
無 | 以 CDR 事件報告來說，這是您 IBM Cloudant 認證相關聯的使用者名稱。1.0.0.5d 版及更新版本。 |
REPORTING_CDR_CLOUDANT_PASSWORD |
無 | 以 CDR 事件報告來說，這是您 IBM Cloudant 認證相關聯的密碼。1.0.0.5d 版及更新版本。 |
REPORTING_CDR_CLOUDANT_APIKEY |
無 | 您 IBM Cloudant 服務的 API 金鑰 apikey 認證。使用您的 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 金鑰。1.0.0.7
版及更新版本。 |
REPORTING_CDR_CLOUDANT_DB_NAME |
無 | 您 CDR 事件的 IBM Cloudant 資料庫名稱。1.0.0.5d 版及更新版本。 |
REPORTING_CDR_CLOUDANT_EVENT_INDEX |
無 | 用來將事件識別為通話詳細記錄 (CDR) 的字串，例如 cdr。指定的值會包含在提報給 IBM Cloudant 資料庫之所有 CDR 事件的索引欄位中。必須定義這個變數，以便產生 CDR 事件來發佈到資料庫。1.0.0.5d 版及更新版本。 |
REPORTING_TRANSCRIPTION_CLOUDANT_ACCOUNT |
無 | 以轉錄事件報告來說，此字串用來定義 IBM Cloudant 帳戶名稱（如果使用者名稱和帳戶名稱不同的話）。在 IBM Cloudant 中，使用者名稱和帳戶名稱通常相同。1.0.0.6 版及更新版本。 |
REPORTING_TRANSCRIPTION_CLOUDANT_URL |
無 | 管理您 IBM Cloudant 實例（用來儲存轉錄事件）所在的 URL。1.0.0.5d 版及更新版本。 |
REPORTING_TRANSCRIPTION_CLOUDANT_USERNAME |
無 | 以轉錄事件報告來說，這是您 IBM Cloudant 認證相關聯的使用者名稱。1.0.0.6 版及更新版本。 |
REPORTING_TRANSCRIPTION_CLOUDANT_PASSWORD |
無 | 以轉錄事件報告來說，這是您 IBM Cloudant 認證相關聯的密碼。1.0.0.6 版及更新版本。 |
REPORTING_TRANSCRIPTION_CLOUDANT_APIKEY |
無 | 您 IBM Cloudant 服務的 API 金鑰 apikey 認證。使用您的 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 金鑰。1.0.0.7
版及更新版本。 |
REPORTING_TRANSCRIPTION_CLOUDANT_DB_NAME |
無 | 您轉錄事件的 IBM Cloudant 資料庫名稱。1.0.0.6 版及更新版本。 |
REPORTING_TRANSCRIPTION_CLOUDANT_EVENT_INDEX |
無 | 用來將事件識別為轉錄事件的字串，例如 transcription。指定的值會包含在提報給 IBM Cloudant 資料庫之所有轉錄事件的索引欄位中。必須定義這個變數，以便產生轉錄事件來發佈到資料庫。1.0.0.6 版及更新版本。 |
REPORTING_CONVERSATION_CLOUDANT_ACCOUNT |
無 | 以 Watson Assistant 各回交談事件報告來說，此字串用來定義 IBM Cloudant 帳戶名稱（如果使用者名稱和帳戶名稱不同的話）。在 IBM Cloudant 中，使用者名稱和帳戶名稱通常相同。1.0.0.6 版及更新版本。 |
REPORTING_CONVERSATION_CLOUDANT_URL |
無 | 管理您 IBM Cloudant 實例（用來儲存各回交談事件）所在的 URL。1.0.0.5d 版及更新版本。 |
REPORTING_CONVERSATION_CLOUDANT_USERNAME |
無 | 以 Watson Assistant 各回交談事件報告來說，這是您 IBM Cloudant 認證相關聯的使用者名稱。1.0.0.6 版及更新版本。 |
REPORTING_CONVERSATION_CLOUDANT_PASSWORD |
無 | 以 Watson Assistant 各回交談事件報告來說，這是您 IBM Cloudant 認證相關聯的密碼。1.0.0.6 版及更新版本。 |
REPORTING_CONVERSATION_CLOUDANT_APIKEY |
無 | 您 IBM Cloudant 服務的 API 金鑰 apikey 認證。使用您的 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 金鑰。1.0.0.7
版及更新版本。 |
REPORTING_CONVERSATION_CLOUDANT_DB_NAME |
無 | 您 Watson Assistant 各回交談事件的 IBM Cloudant 資料庫名稱。1.0.0.6 版及更新版本。 |
REPORTING_CONVERSATION_CLOUDANT_EVENT_INDEX |
無 | 用來將事件識別為 Watson Assistant 各回交談事件的字串，例如 conversation。指定的值會包含在提報給 IBM Cloudant 資料庫之所有各回交談事件的索引欄位中。必須定義這個變數，以便產生轉錄事件來發佈到資料庫。1.0.0.6 版及更新版本。 |
REPORTING_MASK_CALLER_ID |
false |
指出是否遮蔽 CDR 和轉錄報告中的發話端 ID。 |
Watson Assistant 服務和服務編排引擎配置
IBM Watson™ Assistant 服務針對自助式代理程式提供核心人工智慧。相對於直接連接至 Watson Assistant，您可以改以將服務編排引擎整合至代理程式的功能中。如需進一步瞭解，請參閱透過服務編排引擎來連接。
| 環境變數 | 預設值 | 說明 |
|---|---|---|
WATSON_CONVERSATION_WORKSPACE_ID |
無 | Watson Assistant API 的工作區 ID。如需如何尋找工作區 ID 的相關資訊，請參閱 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 |
如果配置 WATSON_CONVERSATION_WORKSPACE_ID，則值為 v1。如果配置 WATSON_ASSISTANT_ID，則值是 v2。 |
要使用的 Watson Assistant API 版本。Voice Gateway 支援 Watson Assistant API 第 1 版和第 2 版。只有 Voice Gateway 1.0.1 版及更新版本中才支援第 2 版。 |
WATSON_CONVERSATION_APIKEY |
無 | 您 Watson Assistant 服務的 API 金鑰 apikey 認證。如需如何尋找服務認證的相關資訊，請參閱 Watson 服務的服務認證。您可以配置 Watson 服務連線，作法是使用 WATSON_CONVERSATION_APIKEY，並將WATSON_CONVERSATION_TOKEN_SERVICE_PROVIDER_URL 設為 https://iam.cloud.ibm.com/identity/token，或是配置 WATSON_CONVERSATION_USERNAME 和 WATSON_CONVERSATION_PASSWORD。僅適用於「雪梨」地區。1.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 建立 Socket 連線時，要等待的時間（秒）。如果超過時間，Voice Gateway 會重新嘗試連接 Watson Assistant。如果仍無法連到服務，則通話失敗。1.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 服務啟用記號鑑別。1.0.0.5a 版及更新版本。 |
WATSON_CONVERSATION_TOKEN_SERVICE_PROVIDER_URL |
https://gateway.watsonplatform.net/authorizatioNonepi/v1/token |
將要求從中取得鑑別記號的 URL。1.0.0.5a 版及更新版本。 |
WATSON_CONVERSATION_TOKEN_SERVICE_URL |
無 | 內嵌在記號要求中的服務 URL，例如 https://gateway.watsonplatform.net/conversatioNonepi 或 https://gateway.watsonplatform.net/assistant/api。1.0.0.5a 版及更新版本。若有啟用記號鑑別，但未定義 WATSON_CONVERSATION_TOKEN_SERVICE_URL，依預設，會使用
WATSON_CONVERSATION_URL 的值。 |
WATSON_ASSISTANT_ID |
無 | Watson Assistant 第 2 版 API 的 Watson Assistant ID。助理 ID 只供 Watson Assistant 第 2 版 API 使用。1.0.1 版及更新版本 |
Watson Virtual Agent 配置
附註：您無法在 2018 年 6 月 19 日之後建立新的 Watson Virtual Agent 實例。此服務已在 2019 年 3 月 19 日從 IBM Cloud 型錄中移除。
| 環境變數 | 預設值 | 說明 |
|---|---|---|
WATSON_VA_URL |
無 | Watson Virtual Agent API 的 url 認證。1.0.0.2 版及更新版本。 |
WATSON_VA_BOT_ID |
無 | Watson Virtual Agent API 的 bot_id 認證。1.0.0.2 版及更新版本。 |
WATSON_VA_CLIENT_ID |
無 | X-IBM-Client-Id 標頭欄位的鑑別金鑰，會在對 Watson Virtual Agent 發出 API 呼叫時使用。1.0.0.2 版及更新版本。 |
WATSON_VA_CLIENT_SECRET |
無 | X-IBM-Client-Secret 標頭欄位的鑑別金鑰，會在對 Watson Virtual Agent 發出 API 呼叫時使用。1.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 用來開啟 Websocket 階段作業的埠。 |
RTP_UDP_PORT_RANGE |
'16384-16394' | UDP 的埠範圍，會設定為字串。 |
SDP_ADDRESS |
localhost |
Answer SDP for SIP 中使用的位址。 |
CLUSTER_WORKERS |
1 |
要大量產生的叢集工作者數目。當設為 0 時，會大量產生等於 1 且小於 CPU 數目的工作者數目。 |
MAX_SESSIONS |
0 |
Media Relay 在停止建立新的媒體階段作業之前，所能同時處理的媒體階段作業數目上限。如果未定義這個變數，會設為 RTP_UDP_PORT_RANGE 變數上所定義的埠數。 |
WATSON_STT_STREAMING_FRAME_SIZE |
100 |
指定要傳送給 Speech to Text 服務之音訊的訊框大小（毫秒）。1.0.0.5 版及更新版本。 |
STT_TRACK_LATENCY |
false |
當設為 true 時，Media Relay 會透過能源偵測方式來追蹤回應延遲。延遲是指從 Media Relay 在發話端語音中偵測到沈默，一直到 Media Relay 收到 Speech to Text 的最終結果，這兩者間所經歷的時間量（毫秒）。1.0.0.8 版及更新版本。 |
RTP_CODECS |
無 | 在 RTP 階段作業期間，Media Relay 支援的轉碼器清單（以逗點區隔）。例如，如果只使用 PCMU，請設為 RTP_CODECS=PCMU。只支援 PCMU、PCMA 和 G722。1.0.0.6a 版及更新版本。 |
EXTERNAL_AUDIO_TRANSFORMS |
無 | 以逗點區隔的 Websocket URL 清單，會指向用來編碼及解碼通話音訊的外部轉碼器服務。例如，如果要連接至轉碼器服務，且它位於正在接聽埠 3500 的 localhost 上，請設為 EXTERNAL_AUDIO_TRANSFORMS=ws://localhost:3500。如需相關資訊，請參閱外部轉碼器服務。1.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 記載警告訊息之前偵測的遺失封包數。1.0.0.1 版及更新版本。 |
錄音配置
如需進一步瞭解如何配置通話錄音，請參閱通話錄音。
| 環境變數 | 預設值 | 說明 |
|---|---|---|
ENABLE_RECORDING |
false |
設為 true，則會在 Media Relay 上啟用通話錄音。請注意，這些記錄可能含有 PHI、PII 和 PCI DSS 機密資料。 |
STEREO_RECORDING |
false |
設為 true，則會將通話錄音到左右聲道。來自 Watson Text to Speech 伺服器或客服中心代理程式的音訊，會錄音到左聲道，來自發話端的音訊會錄音到聲道。如果要啟用立體聲錄音，還必須將 ENABLE_RECORDING 設為 true。1.0.0.4 版及更新版本。 |
RTCP 配置
利用使用 RTCP 來監視 RTP 音訊串流中的「RTP 控制通訊協定 (RTCP)」，以進一步瞭解監視 RTP 音訊串流的相關資訊。
| 環境變數 | 預設值 | 說明 |
|---|---|---|
ENABLE_RTCP |
false |
設為 true，則會啟用「RTP 控制通訊協定 (RTCP)」來監視 RTP 音訊串流。當啟用 RTCP 時，會將在通話期間產生的警告，連同具有音訊串流統計資料的網路摘要，包含在通話詳細記錄 (CDR) 報告事件中。1.0.0.5 版及更新版本。 |
RTCP_MAX_JITTER_THRESHOLD |
30 |
在觸發警告之前，所接收之 RTP 封包之間的抖動毫秒數上限。如果超過此上限，Voice Gateway 會針對受影響的入埠或出埠音訊串流發出警告。1.0.0.5 版及更新版本。 |
RTCP_MAX_PACKET_LOSS_THRESHOLD |
5 |
在觸發警告之前，遺失封包的百分比上限。如果超過此上限，Voice Gateway 會針對受影響的入埠或出埠音訊串流發出警告。1.0.0.5 版及更新版本。 |
安全和 Proxy 配置
如需進一步瞭解如何配置安全，請參閱維護 Voice Gateway 的安全。
| 環境變數 | 預設值 | 說明 |
|---|---|---|
PROXY_TYPE |
http |
定義 Proxy 連線所用的通訊協定。 |
PROXY_HOST |
無 | 轉遞 Proxy 伺服器的主機。 |
PROXY_PORT |
無 | 轉遞 Proxy 伺服器的埠。 |
PROXY_USERNAME |
無 | Proxy 鑑別用的使用者名稱。 |
PROXY_PASSWORD |
無 | Proxy 鑑別用的密碼。 |
WATSON_STT_ENABLE_PROXY |
true |
指出是否經由所配置的 Proxy 來遞送指向 Watson Speech to Text 服務的連線。1.0.0.1a 版及更新版本。 |
WATSON_TTS_ENABLE_PROXY |
true |
指出是否經由所配置的 Proxy 來遞送指向 Watson Text to Speech 服務的連線。1.0.0.1a 版及更新版本。 |
MUSIC_ON_HOLD_ENABLE_PROXY |
false |
指出是否經由所配置的 Proxy 來連接至任何等候音樂或一次性音訊 URL。1.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 的單租戶部署，在部署配置中定義這些變數。若為多租戶 JSON 配置或 IBM Cloud Private 部署，請改以在個別的 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 服務的使用者名稱和密碼型記號鑑別。1.0.0.5a 版及更新版本。 |
WATSON_STT_TOKEN_SERVICE_PROVIDER_URL |
https://stream.watsonplatform.net/authorizatioNonepi/v1/token |
將要求從中取得鑑別記號的 URL。1.0.0.5a 版及更新版本。 |
WATSON_STT_TOKEN_SERVICE_URL |
https://stream.watsonplatform.net/speech-to-text/api |
這是內嵌在記號要求中的服務 URL。1.0.0.5a 版及更新版本。 |
WATSON_STT_APIKEY |
無 | 您 Speech to Text 服務的 API 金鑰 apikey 認證。如需如何尋找服務認證的相關資訊，請參閱 Watson 服務的服務認證。您可以配置 Watson 服務連線，作法是使用 WATSON_STT_APIKEY，並將WATSON_STT_TOKEN_SERVICE_PROVIDER_URL 設為 https://iam.cloud.ibm.com/identity/token，或是配置 WATSON_STT_USERNAME 和 WATSON_STT_PASSWORD。1.0.0.6a 版及更新版本。 |
WATSON_STT_MODEL |
en-US_NarrowbandModel |
Watson Speech to Text 模型。依預設，只援窄頻模型。若要對電話語音進行離線解碼，最好使用預設窄頻模型。如果要在 1.0.0.4 版及更新版本中使用寬頻模型，請參閱啟用寬頻音訊。 |
WATSON_STT_MODEL_VERSION |
無 | 要使用的 Speech to Text 模型版本，例如 en-US_NarrowbandModel.v2017-11-15。只有在您想使用模型的特定版本（而非最新版本）時，才設定這個變數。如需相關資訊請參閱基本模型版本。1.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 |
無 | 用來設定辨識用的自訂語言模型。已淘汰 1.0.1.0 版及更新版本，請改用 WATSON_STT_LANGUAGE_CUSTOMIZATION_ID。 |
WATSON_STT_LANGUAGE_CUSTOMIZATION_ID None |
用來設定辨識用的自訂語言模型。1.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 服務建立 Socket 連線時，要等待的秒數。如果超過時間，Voice Gateway 會重新嘗試連接 Watson Speech to Text 服務。如果仍無法連到服務，則通話失敗。1.0.0.5 版及更新版本。 |
WATSON_STT_REQUEST_TIMEOUT |
5 |
Voice Gateway 在與 Watson Speech to Text 服務建立語音辨識階段作業時，要等待的秒數。如果超過時間，Voice Gateway 會重新嘗試連接 Watson Speech to Text 服務。如果仍無法連到服務，則通話失敗。1.0.0.5 版及更新版本。 |
WATSON_STT_DISABLE_FIRST_TURN_BARGE_IN |
false |
將此值設為 true，以便在第一回交談時，停用語音打斷。1.0.2.0 版及更新版本。 |
BARGE_IN_RESUME |
false |
設為 true 時，如果最終話語的信任評分低於 WATSON_STT_CONFIDENCE_SCORE_THRESHOLD 變數指定的臨界值，則在打斷之後會回復播音訊。如需相關資訊，請參閱配置打斷。1.0.0.5 版及更新版本。 |
ECHO_SUPPRESSION |
false |
設為 true 時，則會抑制因 Text to Speech 合成的回音，而可能產生的 Speech to Text 結果。1.0.0.4c 版及更新版本。 |
只有在您想使用寬頻模型時，才配置下列環境變數。如需相關資訊，請參閱啟用寬頻音訊。
| 環境變數 | 預設值 | 說明 |
|---|---|---|
WATSON_STT_BAND_PREFERENCE |
narrowband |
定義您偏好的音訊頻段，以便在階段作業中協議音訊轉碼器時使用。設為 broadband，則會在可能的情況下使用寬頻。1.0.0.4 版及更新版本。 |
WATSON_STT_BROADBAND_MODEL |
無 | Speech to Text 模型。1.0.0.4 版及更新版本。 |
WATSON_STT_BROADBAND_MODEL_VERSION |
無 | 要使用的 Speech to Text 模型版本，例如 en-US_BroadbandModel.v2017-11-15。只有在您想使用模型的特定版本（而非最新版本）時，才設定這個變數。如需相關資訊請參閱基本模型版本。1.0.0.4c 版及更新版本。 |
WATSON_STT_BROADBAND_OPTOUT |
無 | 設為 true，以拒絕儲存經由 Watson 伺服器上之 Speech to Text 服務傳遞的資料。1.0.0.4 版及更新版本。 |
WATSON_STT_BROADBAND_MAXALTERNATIVES |
無 | 要從 Speech to Text 服務傳回的語音辨識替代方案數目。依預設，會使用 Speech to Text 服務中的值。1.0.0.4 版及更新版本。 |
WATSON_STT_BROADBAND_MODEL_CUSTOMIZATION_ID |
無 | 用來設定辨識用的自訂語言模型。1.0.0.4 版及更新版本。已淘汰 1.0.1.0 版及更新版本，請改用 WATSON_STT_BROADBAND_LANGUAGE_CUSTOMIZATION_ID。 |
WATSON_STT_BROADBAND_LANGUAGE_CUSTOMIZATION_ID |
無 | 用來設定辨識用的自訂語言模型。1.0.1.0 版及更新版本。 |
WATSON_STT_BROADBAND_PROFANITY_FILTER |
無 | 設為 true，則會針對來自 Speech to Text 服務的轉錄，過濾不雅言辭。依預設，會使用 Speech to Text 服務中的值。1.0.0.4 版及更新版本。 |
WATSON_STT_BROADBAND_SMART_FORMATTING |
無 | 指出是否在辨識要求的最終記錄中，將日期、時間、一系列位數和數字、電話號碼、貨幣值和網際網路位址，轉換為可讀性更高的傳統表示法。1.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 服務的使用者名稱和密碼型記號鑑別。1.0.0.5a 版及更新版本。 |
WATSON_TTS_TOKEN_SERVICE_PROVIDER_URL |
https://stream.watsonplatform.net/authorizatioNonepi/v1/token |
要求從中取得記號的 URL。1.0.0.5a 版及更新版本。 |
WATSON_TTS_TOKEN_SERVICE_URL |
https://stream.watsonplatform.net/text-to-speech/api |
這是內嵌在記號要求中的服務 URL。1.0.0.5a 版及更新版本。 |
WATSON_TTS_APIKEY |
無 | 您 Text to Speech 服務的 API 金鑰 apikey 認證。如需如何尋找服務認證的相關資訊，請參閱 Watson 服務的服務認證。您可以配置 Watson 服務連線，作法是使用 WATSON_TTS_APIKEY，並將WATSON_TTS_TOKEN_SERVICE_PROVIDER_URL 設為 https://iam.cloud.ibm.com/identity/token，或是配置 WATSON_TTS_USERNAME 和 WATSON_TTS_PASSWORD。1.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 |
無 | 用來設定「文字轉語音」的自訂語音模型。 |
WATSON_TTS_CONNECTION_TIMEOUT |
5 |
Voice Gateway 在與 Watson Text to Speech 服務建立 Socket 連線時，要等待的秒數。如果超過時間，Voice Gateway 會重新嘗試連接 Watson Text to Speech 服務。如果仍無法連到服務，則通話失敗。1.0.0.5 版及更新版本。 |
WATSON_TTS_REQUEST_TIMEOUT |
5 |
Voice Gateway 在與 Watson Text to Speech 服務建立語音合成階段作業時，要等待的秒數。如果超過時間，Voice Gateway 會重新嘗試連接 Watson Text to Speech 服務。如果仍無法連到服務，則通話失敗。1.0.0.5 版及更新版本。 |
TTS_CACHE_TIME_TO_LIVE |
0 |
為了改善播放回應時間而將 Text to Speech 服務回應快取的時間（小時）。啟用時會快取所有 Text to Speech 回應，除非在 Watson Assistant 對話中設定 vgwExcludeFromTTSCache API 狀態變數來排除回應。請注意，將會快取含有機密 PHI、PII 和 PCI DSS 資料的回應，除非您明確除這些回應不要快取。預設值 0 表示不快取回應。1.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 欄位。 |
安全和 Proxy 配置
如需進一步瞭解如何配置安全，請參閱維護 Voice Gateway 的安全。
| 環境變數 | 預設值 | 說明 |
|---|---|---|
STT_ADAPTER_USERNAME |
無 | 針對來自 Voice Gateway 的連線，在 Speech to Text Adapter 上啟用基本鑑別時使用的使用者名稱。 |
STT_ADAPTER_PASSWORD |
無 | 針對來自 Voice Gateway 的連線，在 Speech to Text Adapter 上進行基本鑑別時使用的密碼。 |
PROXY_TYPE |
http |
定義 Proxy 連線所用的通訊協定，可以是 http 或 https。 |
PROXY_HOST |
無 | 轉遞 Proxy 伺服器的主機。 |
PROXY_PORT |
無 | 轉遞 Proxy 伺服器的埠。 |
PROXY_USERNAME |
無 | Proxy 鑑別用的使用者名稱。 |
PROXY_PASSWORD |
無 | Proxy 鑑別用的密碼。 |
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 |
無 | 選用，特定裝置支援的正常原生音量的音量增益 (dB)。這個變數類似於 Cloud Text-To-Speech AudioConfig 的 volume_gain_db 欄位。 |
安全和 Proxy 配置
如需進一步瞭解如何配置安全，請參閱維護 Voice Gateway 的安全。
| 環境變數 | 預設值 | 說明 |
|---|---|---|
TTS_ADAPTER_USERNAME |
無 | 針對來自 Voice Gateway 的連線，在 Text To Speech Adapter 上啟用基本鑑別時使用的使用者名稱。 |
TTS_ADAPTER_PASSWORD |
無 | 針對來自 Voice Gateway 的連線，在 Text To Speech Adapter 上進行基本鑑別時使用的密碼。 |
PROXY_TYPE |
http |
定義 Proxy 連線所用的通訊協定，可以是 http 或 https。 |
PROXY_HOST |
無 | 轉遞 Proxy 伺服器的主機。 |
PROXY_PORT |
無 | 轉遞 Proxy 伺服器的埠。 |
PROXY_USERNAME |
無 | Proxy 鑑別用的使用者名稱。 |
PROXY_PASSWORD |
無 | Proxy 鑑別用的密碼。 |
SSL_SERVER_PKCS12_FILE |
無 | 含有加密資訊（例如：私密金鑰、憑證和授信憑證管理中心）之 PKCS #12 檔案的位置。指定這個環境變數，以保護來自 Media Relay 的連線。 |
SSL_SERVER_PASSPHRASE |
無 | 用來維護 PKCS #12 檔案安全的通行詞組。 |
出埠通話環境變數
下表列出您可以用來配置出埠通話的環境變數：
| 環境變數 | 預設值 | 說明 |
|---|---|---|
REST_API_USERNAME |
無 | 選用。用於 REST API 呼叫鑑別的使用者名稱。1.0.2 版及更新版本。 |
REST_API_PASSWORD |
無 | 選用。用於 REST API 呼叫鑑別的密碼。1.0.2 版及更新版本。 |
OUTBOUND_CALLS_TENANT_URI |
無 | 選用。租戶 SIP / Tel URI。假設未透過 REST API 提供個別的欄位，則會設定在出埠通話的 From 標頭欄位中。1.0.2 版及更新版本。 |
ENABLE_OUTBOUND_CALLS |
False | 選用。True/False。啟用或停用出埠通話特性。如果設為 'False'，則會拒絕 REST API 呼叫，並發出 403 錯誤回應。1.0.2 版及更新版本。 |
OUTBOUND_CALLS_STATUS_WEBHOOK |
無 | 選用。非同步通知的 HTTP / HTTPS URL。1.0.2 版及更新版本。 |
OUTBOUND_CALLS_STATUS_WEBHOOK_USERNAME |
無 | 選用。傳送通知給 Webhook 時，作為鑑別用的使用者名稱。1.0.2 版及更新版本。 |
OUTBOUND_CALLS_STATUS_WEBHOOK_PASSWORD |
無 | 選用。傳送通知給 Webhook 時，作為鑑別用的密碼。1.0.2 版及更新版本。 |
OUTBOUND_CALLS_STATUS_WEBHOOK_CONNECT_TIMEOUT |
5 | 選用。Voice Gateway 在與 Webhook 建立 Socket 連線時，要等待的時間（秒）。如果超過時間，Voice Gateway 會嘗試重新連接。1.0.2 版及更新版本。 |
OUTBOUND_CALLS_STATUS_WEBHOOK_READ_TIMEOUT |
5 | 選用。Voice Gateway 等待 Webhook 回應的時間（秒）。如果超過時間，Voice Gateway 會嘗試重新連接。1.0.2 版及更新版本。 |
OUTBOUND_CALLS_STATUS_WEBHOOK_MAX_RETRY_NUM |
2 | 選用。因連線失敗，Voice Gateway 嘗試與 Webhook 連接的次數上限。1.0.2 版及更新版本。 |
監視 REST API 環境變數
下表列出您可以用來配置監視的環境變數：
| 環境變數 | 預設值 | 說明 |
|---|---|---|
| METRICS_SAMPLING_INTERVAL | 600 | 選用。要更新度量的間隔秒數。1.0.2 版及更新版本。 |
| ENABLE_METRICS_AUTH | false |
選用。指出是否針對監視端點啟用鑑別。設為 true 時，會以認證來保護端點。請使用 ADMIN_USERNAME 和 ADMIN_PASSWORD 環境變數，來配置鑑別時使用的使用者名稱與密碼。1.0.2 版及更新版本。 |