برای طرح واره YAML و ترتیب بارگذاری به پیکربندی مراجعه کنید.
ورودی های مورد نیاز
sourceLocaleمحل منبع (مثلاً en) برای یافتن فایل های منبع مانند **/*.en.resx استفاده می شود. همچنین به عنوان from=<locale> به ارائه دهنده ارسال شد.
انتخاب ارائه دهنده و مدارک
یک ارائه دهنده را برای هر بار اجرا با provider انتخاب کنید. فقط اطلاعات ارائه دهنده انتخاب شده را ارائه دهید — برای راه اندازی کامل به راهنمای ورودی ها و خروجی ها مراجعه کنید.
providerارائه دهنده ترجمه: azure (پیش فرض)، aws یا google. برای هر فراخوان عملیاتی فقط یک ارائه دهنده استفاده می شود.
subscriptionKeyAzure AI Translator subscription key. برای azure الزامی است. از طریق secrets عبور کنید.
endpointAzure Translator endpoint URL, e.g. 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 در محیط تنظیم شده باشد.
awsFormalityAWS Translate formality setting: FORMAL or INFORMAL.
awsBrevityWhen true, enables AWS Translate brevity mode for supported language pairs.
awsTerminologyNamesAWS Translate custom terminology resource names. Accepts a JSON array or comma-separated values.
awsParallelDataNamesAWS Translate parallel data resource names. Accepts a JSON array or comma-separated values.
googleApiKeyکلید API گوگل کلود. این googleCredentials اتاق عمل را برای google ارائه دهید. عبور از طریق secrets.
googleCredentialsکلید حساب سرویس گوگل کلود به عنوان رشته JSON. این googleApiKey اتاق عمل را برای google ارائه دهید. عبور از طریق secrets.
googleProjectIdشناسه پروژه اختیاری Google Cloud. معمولاً از اعتبارنامه حساب خدمت استنباط می شود.
googleModelGoogle Cloud Translation model, e.g. nmt or base.
googleApiEndpointOptional Google Cloud Translation API endpoint override.
googleAutoRetryOptional Google Cloud Translation automatic retry toggle. Leave unset to use the Google client default.
ورودی های اختیاری رایج
regionمنطقه منبع مترجم (حذف منابع جهانی).
toLocalesمکان هایی برای ترجمه. آرایه JSON (["fr","de"]) یا مقادیر جداشده با کاما را می پذیرد.
includeالگوهای گوی جداشده با خطوط جدید؛ فقط فایل های مشابه ترجمه می شوند.
excludeالگوهای گوی جداشده با خطوط جدید؛ فایل های تطبیقی رد می شوند (بعد از درج اعمال می شوند).
configPathمسیر به فایل پیکربندی YAML (نسبت به ریشه فضای کاری).
changeDetectionSmart 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.
statePathPath 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.
snapshotOnlyWhen 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هنگام true، ترجمه ها را اجرا کنید و خلاصه ها را ارسال کنید اما فایل ها را ننویسید.
failOnErrorوقتی true، خطاهای غیرمنتظره در عمل شکست می خورند؛ وقتی false، خطاها هشدار هستند.
Azure Translator request inputs
این ها مستقیماً به پارامترهای پرس وجوی Azure AI Translator v3 نگاشت می شوند و به ارائه دهنده Azure اعمال می شوند. textType و profanityAction نیز به AWS/Google که معادل آن وجود دارد نگاشت می شوند (راهنمای ارائه دهندگان را ببینید)؛ بقیه فقط Azure هستند. هر کدام اختیاری هستند؛ پیش فرض های ترنسلاتور زمانی که تنظیم نشده باشند اعمال می شوند.
categoryIdAzure Custom Translator دسته — صنعت/حوزه/دکمه صدا. به عنوان ?category=... ارسال شد.
textTypeplain یا html. html فقط زمانی استفاده کنید که مقادیر منابع شما قطعات HTML واقعی باشند.
profanityActionNoAction، Marked یا Deleted. کنترل می کند که چگونه اصطلاحات رکیک در ترجمه ها منتشر شوند.
profanityMarkerAsterisk یا Tag. فقط زمانی معنا دارد که profanityAction Marked باشد.
allowFallbackوقتی false، مترجم به جای بازگشت به سیستم عمومی اگر categoryId شما برای یک مکان هدف استقرار نداشته باشد، خطا برمی گرداند.
apiVersionنسخه API مترجم REST.
تاب آوری و حفاظت موقت
این ورودی ها کنترل می کنند که عمل چگونه رفتار کند وقتی مترجم درخواست شما را محدود می کند و چگونه توکن های موقتی مانند {{name}} یا {0} را در هنگام ترجمه از خراب شدن محافظت می کند.
maxRetriesحداکثر تلاش برای تلاش مجدد برای پاسخ های گذرا HTTP (408, 425, 429, 500, 502, 503, 504). تعداد کل تماس های HTTP در هر درخواست 1 + maxRetries است.
retryBackoffMsسقف (بر حسب میلی ثانیه) در هر خواب تک وقفه ای. این اقدام دقیقاً به هدر پاسخ Retry-After آژور احترام می گذارد؛ در غیر این صورت، از بازگشتی نمایی متزلزل استفاده می کند که در این مقدار محدود شده است.
protectPlaceholdersوقتی true (پیش فرض)، موجودیت های موقتی مانند {{name}}، ${var}، {0}، {0:N2}، %s، %1$s و HTML قبل از ترجمه با توکن های سنتینل جایگزین شده و پس از ترجمه بازیابی می شوند. فقط زمانی غیرفعال کنید که منبع شما عمداً شامل متن موقت و تحت اللفظی باشد که باید ترجمه شود.
customPlaceholderPatternsregexeهای جداشده با خط جدید (بدون جداکننده ها) به مجموعه جایگزین پیش فرض اضافه می شدند، مثلاً <<.+?>> برای نحو توکن سفارشی.
noTranslatePatternsالگوهای گلوب جداشده با خطوط جدید با کلیدهای سطح پارسر مطابقت داشتند (مسیر نقطه دار JSON، name RESX، msgid PO، id واحد XLIFF، کلید INI/restext). کلیدهای تطبیقی از درخواست مترجم حذف شده و با مقدار منبع حفظ شده عبور داده می شوند.
خروجی ها
summary-titleخلاصه کوتاه مناسب عنوان روابط عمومی، مثلاً Machine-translated 320 files, a total of 5,418 translations.
summary-detailsخلاصه مارک داون مناسب برای یک نهاد روابط عمومی یا خلاصه شغل.
has-new-translations'true' زمانی که یک یا چند ترجمه جدید تولید می شد.