Конфигурация · Преводач на ресурси

Презапишете пътя с входа configPath, ако ви трябва нестандартна локация.

Схема

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

Полева справка

provider

Тип: "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

Тип: string

Връща се към sourceLocale входа, ако не е настроен. Също така се препраща към Translator като from=<locale>, така че късите низове не се откриват автоматично.

toLocales

Тип: string[]

Или масив, или низ, разделен със запетая.

include / exclude

Тип: string[]

Моделите на глоба, оценени спрямо абсолютни и относителни на работното пространство пътища.

glossary

Тип: map<string,string>

Преодоляване на термини след превода. Осъзнаване на границите на думите (обработва C++, .NET).

categoryId

Тип: string

Azure Custom Translator категория — вашият регулатор за индустрия/домейн (правен, медицински, маркетингов тон и др.). Изпратено като ?category=....

textType

Тип: "plain" | "html"

По подразбиране е plain. Използвайте html само ако стойностите на ресурсите ви съдържат реални HTML фрагменти.

profanityAction

Тип: "NoAction" | "Marked" | "Deleted"

Как да третираме руфанни термини в преведените изходи.

profanityMarker

Тип: "Asterisk" | "Tag"

Смислено е само когато profanityAction е "Marked".

allowFallback

Тип: boolean

Настрой false да се провали преводът, когато categoryId ти няма внедряване за целева локация, вместо да се върнеш към общия модел.

apiVersion

Тип: string

Версия на REST API за преводач. По подразбиране е 3.0.

awsFormality

Тип: "FORMAL" | "INFORMAL"

AWS Translate formality setting for supported target languages.

awsBrevity

Тип: boolean

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

awsTerminologyNames / awsParallelDataNames

Тип: string[]

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

googleModel

Тип: string

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

googleApiEndpoint

Тип: string

Optional Google Cloud Translation API endpoint override.

googleAutoRetry

Тип: boolean

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

maxRetries

Тип: integer

Максимални опити за повторни опити на преходни HTTP отговори (408, 425, 429, 500, 502, 503, 504). По подразбиране е 5. Общият брой HTTP обаждания на заявка е 1 + maxRetries.

retryBackoffMs

Тип: integer

Лимит (ms) на всяко едно заспиване назад. По подразбиране е 30000. Заглавието Retry-After на Azure се отбелязва точно когато е там; в противен случай се използва треперещ експоненциален откат, ограничен до тази стойност.

protectPlaceholders

Тип: boolean

По подразбиране е true. Когато са включени, токени като {{name}}, ${var}, {0}, {0:N2}, %s, %1$s и HTML обекти се заменят със sentinel токени преди превода и се възстановяват след това. Изключвайте само когато изходният код умишлено съдържа заместващи литерали.

customPlaceholderPatterns

Тип: string[]

Добавени са допълнителни regex шаблони (без делимитери), добавени към стандартния набор за запълване, напр. <<.+?>> за персонализиран синтаксис на токени. Невалидните regex-и се игнорират.

noTranslatePatterns

Тип: string[]

Шаблоните на Glob съвпадаха с ключове на ниво парсер (JSON пунктиран път, RESX name, PO msgid, XLIFF единица id, INI/restext ключ). Съответстващите ключове се изпускат от заявката и преминават през тях с запазена изходна стойност.

changeDetection

Тип: "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

Тип: string

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

Ред на зареждане

Действието чете явни входни данни от работния процес.
Зарежда YAML конфигурацията от configPath.
За всяко споделено поле входът печели; в противен случай се използва стойността YAML.
Обединените стойности се валидират. Невалидните enums (напр. profanityAction: Mask) карат действието бързо да се провали с ясно съобщение.

Тон и индустрия, в прости думи

Azure AI Translator v3 API няма единен тонален бутон. Две настройки се комбинират, за да ви дадат почти същия контрол:

Индустрия / домейн: използвай categoryId, за да посочиш категория Azure Custom Translator, обучена на собствения си корпус — юридически, технически, медицински, маркетингов или каквото и да е друго. Това е най-силният лост за тон, бранд глас и речник.
Текст на повърхността: Използвайте Речник, за да заключите имената на марките и продуктовите термини дословно, и използвайте profanityAction, за да изтриете нецензурни термини при таргетиране на локализация към по-млада аудитория.

Избери езика си

Конфигурация на хранилище

Схема

Полева справка

Ред на зареждане

Тон и индустрия, в прости думи