資源翻譯器

參考資料

輸入與輸出

每個輸入也會被接受在可選的 repo 設定檔中。當兩者都已設定時，行動輸入會獲勝。

本頁

請參閱配置 YAML 架構與載入順序。

所需輸入

所需輸入
名稱	描述
`sourceLocale`	來源位置（例如 `en`）用於尋找資源檔案，如 `*/.en.resx`。也轉發給翻譯器，作為`from=<locale>`。
`subscriptionKey`	Azure AI Translator 訂閱鑰匙。通過`secrets`。
`endpoint`	翻譯端點網址，例如 `https://api.cognitive.microsofttranslator.com/`。

常見的可選輸入

常見的可選輸入
名稱	預設	描述
`region`	沒有	翻譯資源區域（全域資源省略）。
`toLocales`	全部支持。	翻譯地點。接受 JSON 陣列（`["fr","de"]`）或逗號分隔值。
`include`	沒有	新線分離的球狀圖案;僅翻譯相符的檔案。
`exclude`	沒有	新線分離的球狀圖案;會跳過匹配檔案（在 include 後套用）。
`configPath`	`.github/resource-translator.yml`	相對於工作區根目錄的 YAML 設定檔路徑。
`dryRun`	`false`	`true`時，執行翻譯並輸出摘要，但不要寫入檔案。
`failOnError`	`true`	當 `true` 時，意外錯誤會失敗;當`false`時，錯誤就是警告。

轉播器請求輸入

這些參數直接對應到 Azure AI Translator v3 的查詢參數。每一個都可選;未設定時會維持翻譯器預設值。

轉播器請求輸入
名稱	預設	描述
`categoryId`	general	Azure Custom Translator category — the industry/domain/tone knob.轉寄成`?category=...`。
`textType`	`plain`	`plain`或`html`。只有當你的資源值是真實的 HTML 片段時才使用`html`。
`profanityAction`	`NoAction`	`NoAction`、`Marked`或`Deleted`。控制翻譯中髒話的使用方式。
`profanityMarker`	`Asterisk`	`Asterisk`或`Tag`。只有當`profanityAction`是`Marked`時才有意義的。
`allowFallback`	true（譯者預設）	當你`false`時，如果你的`categoryId`沒有針對目標地點的部署，翻譯器會回傳錯誤，而不是回退到一般系統。
`apiVersion`	`3.0`	翻譯器 REST API 版本。

韌性與佔位符保護

這些輸入控制 Translator 限制請求時動作的行為，以及如何保護像 {{name}} 或 {0} 這類佔位標記在翻譯過程中不被破壞。

韌性與佔位保護輸入
名稱	預設	描述
`maxRetries`	`5`	暫時 HTTP 回應的最大重試次數（`408, 425, 429, 500, 502, 503, 504`）。每個請求的 HTTP 呼叫總數為 `1 + maxRetries`。
`retryBackoffMs`	`30000`	任何一次退後睡眠都要以毫秒為單位限制。動作在 Azure `Retry-After`回應標頭出現時會精確執行;否則則使用抖動指數退回，並限制在此值。
`protectPlaceholders`	`true`	當`true`（預設）時，`{{name}}`、`${var}`、`{0}`、`{0:N2}`、`%s`、`%1$s` 和 HTML 實體等佔位符會在翻譯前被哨兵標記取代，翻譯後則恢復。只有當你的來源故意包含需要翻譯的字面佔位文字時，才會停用。
`customPlaceholderPatterns`	沒有	新增換行分隔的正則表達式（無分隔符）加入預設佔位符集，例如 `<<.+?>>` 用於自訂標記語法。
`noTranslatePatterns`	沒有	換行分離的球狀模式與解析器層級鍵（如 JSON 點線路徑、RESX `name`、PO `msgid`、XLIFF 單位`id`、INI/restext 鍵）相匹配。匹配的金鑰會從轉譯器請求中被刪除，並保留其原始值。

輸出

輸出
名稱	描述
`summary-title`	簡短且符合公關標題的摘要，例如Machine-translated 320 files, a total of 5,418 translations。
`summary-details`	適合公關機構或職缺摘要的 Markdown 摘要。
`has-new-translations`	`'true'`產生一個或多個新譯本。