برای طرح واره YAML و ترتیب بارگذاری به پیکربندی مراجعه کنید.
ورودی های مورد نیاز
| نام | توضیحات |
|---|---|
sourceLocale | محل منبع (مثلاً en) برای یافتن فایل های منبع مانند **/*.en.resx استفاده می شود. همچنین به عنوان from=<locale> به مترجم ارسال شد. |
subscriptionKey | Azure AI Translator subscription key. عبور از طریق secrets. |
endpoint | آدرس نقطه پایانی مترجم، مثلاً https://api.cognitive.microsofttranslator.com/. |
ورودی های اختیاری رایج
| نام | پیش فرض | توضیحات |
|---|---|---|
region | هیچ | منطقه منبع مترجم (حذف منابع جهانی). |
toLocales | همه حمایت شده اند | مکان هایی برای ترجمه. آرایه JSON (["fr","de"]) یا مقادیر جداشده با کاما را می پذیرد. |
include | هیچ | الگوهای گوی جداشده با خطوط جدید؛ فقط فایل های مشابه ترجمه می شوند. |
exclude | هیچ | الگوهای گوی جداشده با خطوط جدید؛ فایل های تطبیقی رد می شوند (بعد از درج اعمال می شوند). |
configPath | .github/resource-translator.yml | مسیر به فایل پیکربندی YAML (نسبت به ریشه فضای کاری). |
dryRun | false | هنگام true، ترجمه ها را اجرا کنید و خلاصه ها را ارسال کنید اما فایل ها را ننویسید. |
failOnError | true | وقتی true، خطاهای غیرمنتظره در عمل شکست می خورند؛ وقتی false، خطاها هشدار هستند. |
ورودی های درخواست مترجم
این ها مستقیماً به پارامترهای پرس وجوی Azure AI Translator v3 نگاشت می شوند. هر کدام اختیاری هستند؛ پیش فرض های ترنسلاتور زمانی که تنظیم نشده باشند اعمال می شوند.
| نام | پیش فرض | توضیحات |
|---|---|---|
categoryId | general | Azure Custom Translator دسته — صنعت/حوزه/دکمه صدا. به عنوان ?category=... ارسال شد. |
textType | plain | plain یا html. html فقط زمانی استفاده کنید که مقادیر منابع شما قطعات HTML واقعی باشند. |
profanityAction | NoAction | NoAction، Marked یا Deleted. کنترل می کند که چگونه اصطلاحات رکیک در ترجمه ها منتشر شوند. |
profanityMarker | Asterisk | Asterisk یا Tag. فقط زمانی معنا دارد که profanityAction Marked باشد. |
allowFallback | true (پیش فرض مترجم) | وقتی false، مترجم به جای بازگشت به سیستم عمومی اگر categoryId شما برای یک مکان هدف استقرار نداشته باشد، خطا برمی گرداند. |
apiVersion | 3.0 | نسخه API مترجم REST. |
تاب آوری و حفاظت موقت
این ورودی ها کنترل می کنند که عمل چگونه رفتار کند وقتی مترجم درخواست شما را محدود می کند و چگونه توکن های موقتی مانند {{name}} یا {0} را در هنگام ترجمه از خراب شدن محافظت می کند.
| نام | پیش فرض | توضیحات |
|---|---|---|
maxRetries | 5 | حداکثر تلاش برای تلاش مجدد برای پاسخ های گذرا HTTP (408, 425, 429, 500, 502, 503, 504). تعداد کل تماس های HTTP در هر درخواست 1 + maxRetries است. |
retryBackoffMs | 30000 | سقف (بر حسب میلی ثانیه) در هر خواب تک وقفه ای. این اقدام دقیقاً به هدر پاسخ Retry-After آژور احترام می گذارد؛ در غیر این صورت، از بازگشتی نمایی متزلزل استفاده می کند که در این مقدار محدود شده است. |
protectPlaceholders | true | وقتی true (پیش فرض)، موجودیت های موقتی مانند {{name}}، ${var}، {0}، {0:N2}، %s، %1$s و HTML قبل از ترجمه با توکن های سنتینل جایگزین شده و پس از ترجمه بازیابی می شوند. فقط زمانی غیرفعال کنید که منبع شما عمداً شامل متن موقت و تحت اللفظی باشد که باید ترجمه شود. |
customPlaceholderPatterns | هیچ | regexeهای جداشده با خط جدید (بدون جداکننده ها) به مجموعه جایگزین پیش فرض اضافه می شدند، مثلاً <<.+?>> برای نحو توکن سفارشی. |
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' زمانی که یک یا چند ترجمه جدید تولید می شد. |