有關 YAML 模式和載入順序,請參閱組態。
所需輸入
| 名稱 | 簡介 |
|---|---|
sourceLocale | 來源語言環境(例如en)用於尋找資源檔案,例如**/*.en.resx。 也轉發給譯者作為from=<locale>。 |
subscriptionKey | Azure AI Translator 訂閱金鑰。 過secrets |
endpoint | 翻譯端點 URL,例如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=...。 |
textType | plain | plain html 只有當你嘅資源值係真實嘅HTML片段時,才用html。 |
profanityAction | NoAction | NoAction,Marked,或者Deleted。 控制褻瀆詞喺翻譯中嘅表達方式。 |
profanityMarker | Asterisk | Asterisk Tag 只有當profanityAction Marked時才有意義。 |
allowFallback | true (譯者預設) | false時,Translator 會傳回一個錯誤,而唔會回退到一般系統,如果你嘅categoryId冇為目標地區部署。 |
apiVersion | 3.0 | Translator 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 | 冇 | 換行符分隔的 glob 模式與解析器級鍵(JSON 虛線路徑、RESX name、PO msgid、XLIFF 單位 id、INI/restext 鍵)匹配。 匹配的鍵會從 Translator 請求中刪除並通過,並保留其源值。 |
產出
| 名稱 | 簡介 |
|---|---|
summary-title | 簡短嘅公關標題摘要,例如Machine-translated 320 files, a total of 5,418 translations |
summary-details | Markdown 摘要 適合用於公關機構或工作摘要。 |
has-new-translations | 'true'產生一個或多個新譯本嘅時候。 |