Ukuqwalaselwa kwenkqubo · Umguquli Wezixhobo

Gqithisa indlela ngegalelo configPath ukuba ufuna indawo engagqibekanga.

Isikimu

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

Indawo ekubhekisela kuyo

provider

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

Uhlobo: string

Buyela kwigalelo sourceLocale ukuba ayimiselwanga. Kwakhona ithunyelwe kuMguquleli njengoko from=<locale> imitya emifutshane ayifumaneki ngokuzenzekelayo.

toLocales

Uhlobo: string[]

Nokuba luluhlu okanye umtya owahlulwe ngekoma.

include / exclude

Uhlobo: string[]

Iipateni zeGlob ezivavanywa ngokuchasene neendlela ezipheleleyo kunye neendlela ezinxulumene nomsebenzi.

glossary

Uhlobo: map<string,string>

Ixesha lokuguqulela emva kokuguqulela. Ulwazi lomda wegama (izibambo C++, .NET).

categoryId

Uhlobo: string

Udidi lwe-Azure Custom Translator - ishishini lakho / i-domain knob (ezomthetho, ezonyango, ithoni yokuthengisa, njl.). Ithunyelwe njenge ?category=....

textType

Uhlobo: "plain" | "html"

Ukungaphumeleli plain. Sebenzisa html kuphela ukuba amaxabiso akho ezibonelelo aqulathe iziqwenga zokwenene ze HTML.

profanityAction

Uhlobo: "NoAction" | "Marked" | "Deleted"

Indlela yokujongana namagama ahlambulukileyo kwimveliso yokuguqulela?

profanityMarker

Uhlobo: "Asterisk" | "Tag"

Kuphela xa profanityAction "Marked".

allowFallback

Uhlobo: boolean

Cwangcisa kwi-false ukuze ungaphumeleli uguqulelo xa categoryId yakho ingenakho ukuthunyelwa kwendawo ekujoliswe kuyo endaweni yokubuyela kwimodeli ngokubanzi.

apiVersion

Uhlobo: string

Uguqulelo lwe-API ye-REST UMGUQULI. Ukungaphumeleli 3.0.

awsFormality

Uhlobo: "FORMAL" | "INFORMAL"

AWS Translate formality setting for supported target languages.

awsBrevity

Uhlobo: boolean

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

awsTerminologyNames / awsParallelDataNames

Uhlobo: string[]

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

googleModel

Uhlobo: string

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

googleApiEndpoint

Uhlobo: string

Optional Google Cloud Translation API endpoint override.

googleAutoRetry

Uhlobo: boolean

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

maxRetries

Uhlobo: integer

Ubuninzi beenzame zokuphinda zizame iimpendulo ze-HTTP zexeshana (408, 425, 429, 500, 502, 503, 504). Ukungaphumeleli 5. Iifowuni ezipheleleyo ze-HTTP ngesicelo ngasinye 1 + maxRetries.

retryBackoffMs

Uhlobo: integer

Cap (ms) nakweyiphi na i-backoff yokulala. Ukungaphumeleli 30000. I-Azure's Retry-After header ihlonitshwa kanye xa ikhona; Ngaphandle koko, i-jittered exponential backoff isetyenziswa, efakwe kweli xabiso.

protectPlaceholders

Uhlobo: boolean

Ukungaphumeleli true. Xa ivuliwe, iithokheni ezinje nge-{{name}}, ${var}, {0}, {0:N2}, %s, %1$s kunye ne-HTML zithathelwa indawo ngamathokheni e-sentinel ngaphambi kokuguqulelwa kwaye zibuyiselwe emva koko. Yenza ingasebenzi kuphela xa umthombo uqulethe ngabom iziqulathi ezimile okwendawo.

customPlaceholderPatterns

Uhlobo: string[]

Iipateni ezongezelelweyo ze-regex (ngaphandle kwemida) zongezwa kwiseti yendawo engagqibekanga, umz. <<.+?>> ye-syntax yethokheni yesiko. Ii-regexes ezingaqinisekiswanga azihoywa.

noTranslatePatterns

Uhlobo: string[]

Iipateni ze-Glob ezihambelana namaqhosha okwinqanaba lwe-parser (indlela yamachaphaza e-JSON, i-RESX name, i-PO msgid, iyunithi ye-XLIFF id, iqhosha le-INI/restext). Izitshixo ezihambelanayo ziyasuswa kwisicelo kwaye zidlule ngexabiso lazo lomthombo ligciniwe.

changeDetection

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

Uhlobo: string

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

Ukufaka umyalelo

Isenzo sifunda amagalelo acacileyo avela kumsebenzi womsebenzi.
Ilayisha i-YAML config ukusuka configPath.
Kwintsimi nganye ekwabelwana ngayo, igalelo liyaphumelela; Ngaphandle koko, ixabiso le-YAML lisetyenziswa.
Amaxabiso adityanisiweyo aqinisekisiwe. I-enums engasebenziyo (umz. profanityAction: Mask) yenza isenzo singaphumeleli ngokukhawuleza ngomyalezo ocacileyo.

Ithoni kunye neShishini, ngokucacileyo

I-Azure AI Translator v3 API ayinayo iqhosha elinye leethoni. Izicwangciso ezimbini zidibeneyo ukukunika uninzi lolawulo olufanayo:

Umzi-mveliso / indawo: Sebenzisa categoryId ukukhomba kudidi lwe-Azure Custom Translator oluqeqeshwe kwi-corpus yakho - ezomthetho, ubuchwephesha, ezonyango, ukuthengisa, okanye nantoni na enye. Le yeyona lever inamandla kwithoni, ilizwi lophawu, kunye nesigama.
Umbhalo wokomhlaba: Sebenzisa i-I-Glossary ukutshixa amagama e-brand kunye nemigaqo yemveliso verbatim, kwaye usebenzise i-profanityAction ukucoca amagama angcolileyo xa ujolise ekuhlaleni kwabaphulaphuli abancinci.

Khetha ulwimi lwakho

Ukumiselwa kwendawo yokugcina izinto

Isikimu

Indawo ekubhekisela kuyo

Ukufaka umyalelo

Ithoni kunye neShishini, ngokucacileyo