参考资料

输入与输出

每个输入也在可选的存储库配置文件中被接受。当两者都设置时,动作输入获胜。

本页内容

有关 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`时,如果您的`categoryId`没有目标区域设置的部署,则 Translator 返回错误,而不是回退到通用系统。
`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'`当产生一个或多个新译本时。