Konfigurasie · Hulpbronvertaler

Oorskryf die pad met die configPath inset as jy 'n nie-standaard ligging nodig het.

Skema

# .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.*"

Veldverwysing

provider

Tipe: "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

Tipe: string

Dit val terug op die sourceLocale inset as dit nie gestel is nie. Dit word ook as from=<locale> na Vertaler gestuur sodat kort stringe nie outomaties opgespoor word nie.

toLocales

Tipe: string[]

Of 'n skikking of 'n komma-geskeide string.

include / exclude

Tipe: string[]

Glob-patrone geëvalueer teen absolute en werksruimte-relatiewe paaie.

glossary

Tipe: map<string,string>

Term-oorskrywings na vertaling. Woordgrensbewus (hanteer C++, .NET).

categoryId

Tipe: string

Azure Custom Translator kategorie — jou bedryf/domeinknop (reg, medies, bemarkingstoon, ens.). Gestuur as ?category=....

textType

Tipe: "plain" | "html"

Standaard is plain. Gebruik html slegs as jou hulpbronwaardes regte HTML-fragmente bevat.

profanityAction

Tipe: "NoAction" | "Marked" | "Deleted"

Hoe om vloekwoorde in vertaalde uitsette te hanteer.

profanityMarker

Tipe: "Asterisk" | "Tag"

Net betekenisvol wanneer profanityAction "Marked" is.

allowFallback

Tipe: boolean

Stel dit op false om die vertaling te misluk wanneer jou categoryId geen ontplooiing vir 'n teikenplek het nie, in plaas daarvan om terug te val op die algemene model.

apiVersion

Tipe: string

Vertaler REST API-weergawe. Standaard is 3.0.

awsFormality

Tipe: "FORMAL" | "INFORMAL"

AWS Translate formality setting for supported target languages.

awsBrevity

Tipe: boolean

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

awsTerminologyNames / awsParallelDataNames

Tipe: string[]

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

googleModel

Tipe: string

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

googleApiEndpoint

Tipe: string

Optional Google Cloud Translation API endpoint override.

googleAutoRetry

Tipe: boolean

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

maxRetries

Tipe: integer

Maksimum herpogingspogings op tydelike HTTP-antwoorde (408, 425, 429, 500, 502, 503, 504). Standaard is 5. Die totale HTTP-oproepe per versoek is 1 + maxRetries.

retryBackoffMs

Tipe: integer

Kap (MS) op enige enkele terug-af-slaap. Standaard is 30000. Azure se Retry-After-kop word presies geëer wanneer dit teenwoordig is; andersins word 'n gejitterde eksponensiële terugslag gebruik, beperk tot hierdie waarde.

protectPlaceholders

Tipe: boolean

Standaard is true. Wanneer dit aan is, word tokens soos {{name}}, ${var}, {0}, {0:N2}, %s, %1$s en HTML-entiteite vervang met sentinel-tokens voor vertaling en daarna herstel. Deaktiveer slegs wanneer die bron doelbewus plekhouer-vormige letterlikes bevat.

customPlaceholderPatterns

Tipe: string[]

Ekstra regex-patrone (sonder afbakeners) is by die standaard plekhouerstel gevoeg, bv. <<.+?>> vir pasgemaakte token-sintaksis. Ongeldige regexe word geïgnoreer.

noTranslatePatterns

Tipe: string[]

Glob-patrone het ooreenstem met parservlak-sleutels (JSON gestippelde pad, RESX name, PO msgid, XLIFF eenheid id, INI/restext sleutel). Ooreenstemmende sleutels word uit die versoek verwyder en deurgegee met hul bronwaarde behou.

changeDetection

Tipe: "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

Tipe: string

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

Laaivolgorde

Die aksie lees eksplisiete insette uit die werkvloei.
Dit laai die YAML-konfigurasie van configPath.
Vir elke gedeelde veld wen die inset; andersins word die YAML-waarde gebruik.
Die saamgevoegde waardes word gevalideer. Ongeldige enums (bv. profanityAction: Mask) veroorsaak dat die aksie vinnig misluk met 'n duidelike boodskap.

Toon en industrie, in eenvoudige terme

Die Azure AI Translator v3 API het nie 'n enkele toonknop nie. Twee instellings kombineer om jou die meeste van dieselfde beheer te gee:

Bedryf / domein: gebruik categoryId om na 'n Azure Custom Translator-kategorie te wys wat op jou eie korpus opgelei is — regs, tegnies, medies, bemarking, of enigiets anders. Dit is die sterkste hefboom vir toon, handelsmerkstem en woordeskat.
Oppervlakteks: Gebruik die Woordelys om handelsname en produkterme woordeliks te sluit, en gebruik profanityAction om vloekwoorde te verwyder wanneer lokalisering vir jonger gehore geteiken word.

Kies jou taal

Bewaarplekkonfigurasie

Skema

Veldverwysing

Laaivolgorde

Toon en industrie, in eenvoudige terme