Uppsetning · Resource Translator

Yfirskrifaðu leiðina með configPath inntakinu ef þú þarft staðsetningu sem er ekki sjálfgefin.

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

Sviðsvísun

provider

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

Tegund: string

Fellur aftur í sourceLocale inntak ef það er ekki stillt. Einnig sent til þýðanda sem from=<locale> svo stuttir strengir séu ekki sjálfkrafa greindir.

toLocales

Tegund: string[]

Annað hvort fylki eða kommuaðskilinn strengur.

include / exclude

Tegund: string[]

Glob-mynstur metin út frá algildum og vinnusvæðum hlutfallslegum leiðum.

glossary

Tegund: map<string,string>

Yfirskriftir eftir þýðingu. Meðvitaður um orðmörk (meðhöndlar C++, .NET).

categoryId

Tegund: string

Azure Custom Translator flokkur — iðnaðar-/sviðshnappurinn þinn (lögfræðilegur, læknisfræðilegur, markaðstónn o.s.frv.). Sent sem ?category=....

textType

Tegund: "plain" | "html"

Sjálfgefið plain. Notaðu html aðeins ef auðlindagildin þín innihalda raunveruleg HTML-brot.

profanityAction

Tegund: "NoAction" | "Marked" | "Deleted"

Hvernig á að meðhöndla blótsyrði í þýddum texta.

profanityMarker

Tegund: "Asterisk" | "Tag"

Aðeins merkingarbær þegar profanityAction er "Marked".

allowFallback

Tegund: boolean

Stilltu á false að þýðingin mistakist þegar categoryId þín hefur enga dreifingu fyrir markstað í stað þess að falla aftur í almenna líkanið.

apiVersion

Tegund: string

Þýðandi REST API útgáfa. Sjálfgefið 3.0.

awsFormality

Tegund: "FORMAL" | "INFORMAL"

AWS Translate formality setting for supported target languages.

awsBrevity

Tegund: boolean

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

awsTerminologyNames / awsParallelDataNames

Tegund: string[]

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

googleModel

Tegund: string

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

googleApiEndpoint

Tegund: string

Optional Google Cloud Translation API endpoint override.

googleAutoRetry

Tegund: boolean

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

maxRetries

Tegund: integer

Hámarks tilraunir til endurtekninga á tímabundnum HTTP-svörum (408, 425, 429, 500, 502, 503, 504). Sjálfgefið 5. Heildarfjöldi HTTP-símtala á beiðni er 1 + maxRetries.

retryBackoffMs

Tegund: integer

Takmörkun (MS) á hvaða einstöku svefni sem er. Sjálfgefið 30000. Azure Retry-After hausinn er virtur nákvæmlega þegar hann er til staðar; annars er notaður jitteraður veldisvöxtur aftur, takmarkaður við þetta gildi.

protectPlaceholders

Tegund: boolean

Sjálfgefið true. Þegar kveikt er á eru tákn eins og {{name}}, ${var}, {0}, {0:N2}, %s, %1$s og HTML einingar skipt út fyrir sentinel-tákn fyrir þýðingu og endurheimt eftir það. Slökktu aðeins á þegar uppsprettan inniheldur viljandi staðgengilslaga bókstafa.

customPlaceholderPatterns

Tegund: string[]

Auka regex-mynstur (án afmarkana) bætt við sjálfgefna staðsetningarsettið, t.d. <<.+?>> fyrir sérsniðna táknasetningu. Ógild regex eru hunsuð.

noTranslatePatterns

Tegund: string[]

Glob-mynstur pöruðust við parser-stig lykla (JSON dotted path, RESX name, PO msgid, XLIFF unit id, INI/restext lykill). Samsvarandi lyklar eru felldir út úr beiðninni og sendir áfram með upprunagildi þeirra varðveitt.

changeDetection

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

Tegund: string

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

Hleðsluröð

Aðgerðin les skýrar inntök úr vinnuflæðinu.
Það hleður YAML stillingunni frá configPath.
Fyrir hvern sameiginlegan reit, vinnur inntakið; annars er YAML-gildið notað.
Sameinuðu gildin eru staðfest. Ógild enums (t.d. profanityAction: Mask) valda því að aðgerðin mistekst hratt með skýru skilaboði.

Tónn og iðnaður, í einföldum orðum

Azure AI Translator v3 API hefur ekki einn tónhnapp. Tvær stillingar sameinast og gefa þér mest af sömu stjórn:

Iðnaður / svið: Notaðu categoryId til að benda á Azure Custom Translator flokk sem er þjálfaður á þínu eigin safni — lögfræðilegt, tæknilegt, læknisfræðilegt, markaðsfræðilegt eða eitthvað annað. Þetta er sterkasta stöngin fyrir tón, rödd vörumerkisins og orðaforða.
Yfirborðstexti: Notaðu Orðalisti til að læsa vörumerkjum og vöruhugtökum orðrétt, og notaðu profanityAction til að hreinsa út blótsyrði þegar þú miðar að staðfærslu fyrir yngri áhorfendur.

Veldu þitt tungumál

Uppsetning geymslu

Skema

Sviðsvísun

Hleðsluröð

Tónn og iðnaður, í einföldum orðum