Configuração · Tradutor de Recursos

Substitui o caminho com a entrada configPath se precisares de uma localização não padrão.

Esquema

# .github/resource-translator.yml
sourceLocale: en

# Provider config can be nested. Keep secrets in workflow inputs; use repo
# config for non-secret defaults like region, model, formality, or category.
provider:
  azure:
    categoryId: my-custom-translator-category
    apiVersion: "3.0"
    allowFallback: true

toLocales:
  - fr
  - de
  - es
include:
  - "src/**/*.en.json"
  - "apps/**/*.en.resx"
exclude:
  - "**/__tests__/**"
glossary:
  Acme: Contoso
  Octocat: Octocat   # keep brand names verbatim

# Translator request shape — most users can ignore these.
textType: plain                  # plain | html
profanityAction: NoAction        # NoAction | Marked | Deleted
profanityMarker: Asterisk        # Asterisk | Tag (only when profanityAction == Marked)

# Resilience — Translator returns 429 under load. Defaults are usually
# fine; tune only if your runs are large enough to hit them.
maxRetries: 5
retryBackoffMs: 30000             # cap on any single backoff sleep (ms)

# Placeholder protection. ON by default — wraps tokens like {{name}},
# {0}, %s, ${var} into sentinels before translation and restores them
# on the way back. Set false only when source intentionally contains
# placeholder-shaped literals.
protectPlaceholders: true
customPlaceholderPatterns:
  - "<<.+?>>"                     # any extra token syntax you use

# Per-key opt-out. Keys matching any glob are dropped from the request
# and pass through with the source value preserved.
noTranslatePatterns:
  - "errors.code.*"
  - "brands.*"

Referência de campo

provider

Tipo: "azure" | "aws" | "google" | provider block

Either a provider string or a nested provider block (provider.azure, provider.aws, or provider.google). Prefer nested blocks for provider-specific settings; keep secrets in workflow inputs rather than committed config.

sourceLocale

Tipo: string

Volta ao input sourceLocale se não estiver definido. Também encaminhado para o Tradutor como from=<locale> para que as cadeias curtas não sejam detetadas automaticamente.

toLocales

Tipo: string[]

Ou um array ou uma cadeia separada por vírgulas.

include / exclude

Tipo: string[]

Padrões de globos avaliados contra caminhos absolutos e relativos ao espaço de trabalho.

glossary

Tipo: map<string,string>

Substituições de termos pós-tradução. Consciente da fronteira de palavras (trata C++, .NET).

categoryId

Tipo: string

Azure Custom Translator categoria — o seu knob de indústria/domínio (legal, médico, tom de marketing, etc.). Enviado como ?category=....

textType

Tipo: "plain" | "html"

Por defeito, é plain. Usa html apenas se os valores dos teus recursos contiverem fragmentos HTML reais.

profanityAction

Tipo: "NoAction" | "Marked" | "Deleted"

Como tratar termos profanos em saídas traduzidas.

profanityMarker

Tipo: "Asterisk" | "Tag"

Só é significativo quando profanityAction é "Marked".

allowFallback

Tipo: boolean

Defina para false falhar a tradução quando o seu categoryId não tiver deployment para um local alvo, em vez de recorrer ao modelo geral.

apiVersion

Tipo: string

Tradutor versão da API REST. Por defeito, é 3.0.

awsFormality

Tipo: "FORMAL" | "INFORMAL"

AWS Translate formality setting for supported target languages.

awsBrevity

Tipo: boolean

Set to true to enable AWS Translate brevity mode for supported language pairs.

awsTerminologyNames / awsParallelDataNames

Tipo: string[]

AWS Translate custom terminology and parallel data resource names. Either an array or comma-separated string.

googleModel

Tipo: string

Google Cloud Translation model, e.g. nmt or base.

googleApiEndpoint

Tipo: string

Optional Google Cloud Translation API endpoint override.

googleAutoRetry

Tipo: boolean

Optional Google Cloud Translation automatic retry toggle. Leave unset to use the Google client default.

maxRetries

Tipo: integer

Tentativas máximas em respostas HTTP transitórias (408, 425, 429, 500, 502, 503, 504). Por defeito, é 5. O total de chamadas HTTP por pedido é 1 + maxRetries.

retryBackoffMs

Tipo: integer

Limite (ms) em qualquer sono de recuo individual. Por defeito, é 30000. O cabeçalho Retry-After do Azure é honrado exatamente quando presente; caso contrário, é utilizado um recuo exponencial com tremor, limitado a este valor.

protectPlaceholders

Tipo: boolean

Por defeito, é true. Quando ativados, tokens como {{name}}, ${var}, {0}, {0:N2}, %s, %1$s e entidades HTML são substituídos por tokens sentinela antes da tradução e restaurados depois. Desative apenas quando a fonte contiver intencionalmente literais em forma de marcador de lugar.

customPlaceholderPatterns

Tipo: string[]

Padrões regex extra (sem delimitadores) adicionados ao conjunto de marcadores padrão, por exemplo, <<.+?>> para sintaxe personalizada dos tokens. Regexes inválidos são ignorados.

noTranslatePatterns

Tipo: string[]

Os padrões glob coincidiam com chaves ao nível do parser (JSON doted path, RESX name, PO msgid, unidade XLIFF id, chave INI/restext). As chaves correspondentes são eliminadas do pedido e passam com o seu valor de origem preservado.

changeDetection

Tipo: "smart" | "disabled"

Defaults to smart. Uses the committed state manifest to translate only changed or missing parser keys. Set to disabled or false to preserve the legacy always-translate behavior.

statePath

Tipo: string

Path to the deterministic smart change-detection state manifest. Defaults to .github/resource-translator-state.json.

Ordem de carregamento

A ação lê entradas explícitas do fluxo de trabalho.
Carrega a configuração YAML a partir de configPath.
Para cada campo partilhado, a entrada vence; caso contrário, é utilizado o valor YAML.
Os valores fundidos são validados. Enums inválidos (por exemplo, profanityAction: Mask) fazem com que a ação falhe rapidamente com uma mensagem clara.

Tom e indústria, em termos claros

A API Azure AI Translator v3 não tem um único botão de tom. Duas definições combinam-se para lhe dar a maior parte do mesmo controlo:

Indústria / domínio: Usa-categoryId para apontar para uma categoria Azure Custom Translator treinada com base no teu próprio corpus — legal, técnico, médico, marketing ou qualquer outra coisa. Esta é a alavanca mais forte para tom, voz de marca e vocabulário.
Texto superficial: Use o Glossário para bloquear nomes de marcas e termos de produto literalmente, e utilize profanityAction para eliminar termos profanes ao direcionar a localização para públicos mais jovens.

Escolha a sua língua

Configuração do repositório

Esquema

Referência de campo

Ordem de carregamento

Tom e indústria, em termos claros