Входи та виходи · Перекладач ресурсів

Дивіться Конфігурація для схеми YAML та порядку завантаження.

Необхідні вхідні дані

sourceLocale

Локація джерела (наприклад, en) використовується для пошуку файлів ресурсів, таких як **/*.en.resx. Також переадресовано постачальнику як from=<locale>.

Вибір постачальника та кваліфікація

Обирайте одного провайдера на кожен рейс з provider. Вказуйте лише кваліфікацію обраного провайдера — дивіться Входи та виходи посібник для повного налаштування.

provider

За замовчуванням: azure

Постачальник перекладу: azure (за замовчуванням), aws або google. На кожен дзвінок використовується лише один провайдер.

subscriptionKey

За замовчуванням: жодних

Ключ підписки Azure AI Translator. Обов'язкове для azure. Проїжджайте через secrets.

endpoint

За замовчуванням: жодних

Azure Translator endpoint URL, наприклад https://api.cognitive.microsofttranslator.com/. Обов'язкове для azure.

awsAccessKeyId

За замовчуванням: жодних

Ідентифікатор ключа доступу AWS. Опціонально — опустити (з awsSecretAccessKey) використання стандартного ланцюга облікових даних AWS / OIDC. Проїжджайте через secrets.

awsSecretAccessKey

За замовчуванням: жодних

Секретний ключ доступу AWS. Потрібно подавати разом із awsAccessKeyId. Проїжджайте через secrets.

awsSessionToken

За замовчуванням: жодних

Необов'язковий токен AWS для тимчасових облікових даних. Проїжджайте через secrets.

awsRegion

За замовчуванням: жодних

регіон AWS для сервісу Translate (наприклад, us-east-1). Обов'язковий для aws, якщо AWS_REGION не встановлений у навколишньому середовищі.

awsFormality

За замовчуванням: жодних

AWS Translate formality setting: FORMAL or INFORMAL.

awsBrevity

За замовчуванням: жодних

When true, enables AWS Translate brevity mode for supported language pairs.

awsTerminologyNames

За замовчуванням: жодних

AWS Translate custom terminology resource names. Accepts a JSON array or comma-separated values.

awsParallelDataNames

За замовчуванням: жодних

AWS Translate parallel data resource names. Accepts a JSON array or comma-separated values.

googleApiKey

За замовчуванням: жодних

Ключ Google Cloud API. Надайте цю АБО googleCredentials для google. Проїжджайте через secrets.

googleCredentials

За замовчуванням: жодних

Google Cloud service-account key як JSON-рядок. Надайте цю АБО googleApiKey для google. Проїжджайте через secrets.

googleProjectId

За замовчуванням: жодних

Опціональний ідентифікатор проєкту Google Cloud. Зазвичай це виводиться з облікових даних сервісного акаунта.

googleModel

За замовчуванням: жодних

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

googleApiEndpoint

За замовчуванням: жодних

Optional Google Cloud Translation API endpoint override.

googleAutoRetry

За замовчуванням: жодних

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

Поширені опціональні входи

region

За замовчуванням: жодних

Регіон ресурсів перекладача (опустити для глобальних ресурсів).

toLocales

За замовчуванням: усі підтримуються

Місця для перекладу. Приймає масив JSON (["fr","de"]) або значення, розділені комами.

include

За замовчуванням: жодних

Візерунки, розділені по новолінії; перекладаються лише відповідні файли.

exclude

За замовчуванням: жодних

Візерунки, розділені по новолінії; Відповідні файли пропускаються (застосовуються після включення).

configPath

За замовчуванням: .github/resource-translator.yml

Шлях до конфігураційного файлу YAML (відносно кореня робочого простору).

changeDetection

За замовчуванням: smart

Smart change detection mode. smart translates only keys whose source value, target presence, state entry, or translation-affecting settings require it. Use disabled or false to send every eligible key on every run.

statePath

За замовчуванням: .github/resource-translator-state.json

Path to the compact deterministic smart change-detection state manifest. Defaults to .github/resource-translator-state.json; commit it so future runs can audit and reuse unchanged translations.

snapshotOnly

За замовчуванням: false

When true, create/update the smart change-detection manifest from existing source and target files without calling a translation provider or writing target resource files. Useful when bootstrapping statePath while a provider is unavailable.

dryRun

За замовчуванням: false

Коли true, запускайте переклади та видавайте резюме, але не записуйте файли.

failOnError

За замовчуванням: true

Коли true, несподівані помилки не дають дії; коли false, помилки — це попередження.

Azure Translator request inputs

Вони безпосередньо відображаються з параметрами запиту Azure AI Translator v3 і застосовуються до провайдера Azure. textType і profanityAction також відносяться до AWS/Google, де існує еквівалент (див. посібник провайдера); решта — лише Azure. Кожен з них є необов'язковим; стандартні налаштування Translator застосовуються, коли не встановлено.

categoryId

За замовчуванням: general

Azure Custom Translator category — ручка industry/domain/tone. Переслано як ?category=....

textType

За замовчуванням: plain

plain чи html. Використовуйте html лише тоді, коли ваші значення ресурсу — це справжні HTML-фрагменти.

profanityAction

За замовчуванням: NoAction

NoAction, Marked чи Deleted. Контролює, як нецензурні терміни вимовляються в перекладах.

profanityMarker

За замовчуванням: Asterisk

Asterisk чи Tag. Це має сенс лише тоді, коли profanityAction Marked.

allowFallback

За замовчуванням: true (перекладач за замовчуванням)

Коли false, Translator повертає помилку замість того, щоб повертатися до загальної системи, якщо у вашому categoryId немає розгортання для цільової локації.

apiVersion

За замовчуванням: 3.0

Версія REST API перекладача.

Стійкість і тимчасовий захист

Ці входи контролюють, як поводиться дія, коли Перекладач обмежує ваш запит, і як він захищає тимчасові токени, такі як {{name}} чи {0}, від пошкодження під час перекладу.

maxRetries

За замовчуванням: 5

Максимальна кількість повторних спроб для тимчасових HTTP-відповідей (408, 425, 429, 500, 502, 503, 504). Загальна кількість HTTP-дзвінків на запит становить 1 + maxRetries.

retryBackoffMs

За замовчуванням: 30000

Обмеження (у мілісекундах) на будь-який один відступ сну. Дія вшановує заголовок відповіді Azure Retry-After саме тоді, коли він присутній; інакше використовується тремтливий експоненціальний відступ, обмежений цим значенням.

protectPlaceholders

За замовчуванням: true

Коли true (за замовчуванням), заповнювачі, такі як {{name}}, ${var}, {0}, {0:N2}, %s, %1$s та HTML-сутності, замінюються на сентинельні токени перед перекладом і відновлюються після. Вимикайте лише тоді, коли ваше джерело навмисно містить буквальний текст у формі заповнювачів, який слід перекладати.

customPlaceholderPatterns

За замовчуванням: жодних

Новорядкові регулярні вирази (без розділівників) додаються до стандартного набору заповнювачів, наприклад, <<.+?>> для синтаксису власних токенів.

noTranslatePatterns

За замовчуванням: жодних

Патерни глобів, розділені за новими рядками, відповідали ключовим ключам рівня парсера (JSON пунктирний шлях, RESX name, PO msgid, XLIFF unit id, INI/restext ключ). Відповідні ключі відкидаються з запиту Translator і пропускаються з збереженням їхнього вихідного значення.

Виходи

summary-title

Коротке резюме, зручне для PR-заголовків, наприклад, Machine-translated 320 files, a total of 5,418 translations.

summary-details

Підсумок розмітки підходить для PR-організації або резюме вакансії.

has-new-translations

'true' коли генерувалися один або кілька нових перекладів.