Uppseting · Keldutýðari

Yvirskriva leiðina við configPath inntakinum, um tú hevur tørv á einum stað, sum ikki er standard.

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

Feltreferensa

provider

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

Slag: string

Fellur aftur til sourceLocale inntakið, um tað ikki er sett. Sendi eisini víðari til Translator sum from=<locale> so stuttir strengir ikki verða sjálvvirkandi uppdagaðir.

toLocales

Slag: string[]

Antin ein fylki ella ein komma-separeraður strengur.

include / exclude

Slag: string[]

Glob-mynstur mett móti absoluttum og arbeiðspláss-relativum leiðum.

glossary

Slag: map<string,string>

Eftir týðing yvirskrivar orðini. Orðamarka-viðvitan (handfer C++, .NET).

categoryId

Slag: string

Azure Custom Translator kategori — tín vinnu-/økisknappur (lógligur, læknaligur, marknaðarføringstónur o.s.fr.). Sendur sum ?category=....

textType

Slag: "plain" | "html"

Sjálvvirkandi er plain. Brúka html bert um tíni tilfeingisvirði innihalda veruligar HTML-brot.

profanityAction

Slag: "NoAction" | "Marked" | "Deleted"

Hvussu tú viðger grov orð í týddum úrslitum.

profanityMarker

Slag: "Asterisk" | "Tag"

Bert týdningarmikil, tá profanityAction er "Marked".

allowFallback

Slag: boolean

Set til false at miseydnast við umsetingini, tá categoryId ikki hevur útseting fyri eitt málstað, heldur enn at detta aftur til almenna modellið.

apiVersion

Slag: string

Translator REST API útgáva. Sjálvvirkandi er 3.0.

awsFormality

Slag: "FORMAL" | "INFORMAL"

AWS Translate formality setting for supported target languages.

awsBrevity

Slag: boolean

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

awsTerminologyNames / awsParallelDataNames

Slag: string[]

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

googleModel

Slag: string

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

googleApiEndpoint

Slag: string

Optional Google Cloud Translation API endpoint override.

googleAutoRetry

Slag: boolean

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

maxRetries

Slag: integer

Maksimum royndir við stuttvarandi HTTP-svarum (408, 425, 429, 500, 502, 503, 504). Sjálvvirkandi er 5. Tilsamans HTTP-kall pr. fyrispurning er 1 + maxRetries.

retryBackoffMs

Slag: integer

Tak (ms) á hvørjum einstøkum backoff-svevn. Sjálvvirkandi er 30000. Azure's Retry-After høvuð verður heiðrað júst tá hon er til staðar; annars verður jitterað eksponentiellt backoff brúkt, avmarkað til hetta virðið.

protectPlaceholders

Slag: boolean

Sjálvvirkandi er true. Tá tey eru tendrað, verða token sum {{name}}, ${var}, {0}, {0:N2}, %s, %1$s og HTML eindir skiftar út við sentinel-token áðrenn umseting og síðani endurstovnað. Sløkk bert tá keldan við vilja inniheldur plásshaldara-líknandi literals.

customPlaceholderPatterns

Slag: string[]

Eyka regex-mynstur (uttan avmarkarar) vórðu lagdar afturat sjálvvalda plásshaldarasettinum, t.d. <<.+?>> fyri egna token-syntaks. Ógild regex verða ikki tikin í álvara.

noTranslatePatterns

Slag: string[]

Glob-mynstur samsvaraðu við parser-stigs lyklar (JSON punktaleið, RESX name, PO msgid, XLIFF eind id, INI/restext lykil). Samsvarandi lyklar verða tiknir burtur úr umbønini og fara víðari við upprunavirðinum varðveittum.

changeDetection

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

Slag: string

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

Lastarrøð

Gerðin lesur greiðar inntøkur úr arbeiðsgongdini.
Tað lastar YAML-uppsetingina frá configPath.
Fyri hvørt felags felt vinnur inntakið; annars verður YAML-virðið brúkt.
Tey samanlagdu virðini verða váttað. Ógild enums (t.d. profanityAction: Mask) fáa handlingina at miseydnast skjótt við greiðum boðum.

Tónur og ídnaður, í greiðum orðum

Azure AI Translator v3 API hevur ikki ein einasta tónaknøtt. Tvey stillingar sameinast og geva tær mest sum sama stýring:

Vinna / øki: brúka categoryId til at vísa á ein Azure Custom Translator bólk, sum er venjdur á tínum egna korpus — løgfrøðiliga, tøkniliga, læknaliga, marknaðarførslu ella okkurt annað. Hetta er sterkasti spakin fyri tónalag, brand-rødd og orðaforða.
Yvirflatutekstur: Brúka The Orðalisti til at læsa vørunøvn og vøruorð orð fyri orð, og brúka profanityAction til at strika burtur grov orð, tá tú miðar lokalisering til yngri málbólkar.

Vel títt mál

Repository-uppseting

Skema

Feltreferensa

Lastarrøð

Tónur og ídnaður, í greiðum orðum