תצורה · מתרגם משאבים

עקף את הנתיב עם קלט 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 אם לא מוגדר. גם הועברתי למתרגם 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

גרסת API של REST למתרגם (REST). ברירת המחדל היא 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) בכל שינת Backoff בודדת. ברירת המחדל היא 30000. הכותרת Retry-After של אזור מכובדת בדיוק כשהיא נוכחת; אחרת משתמשים בחזרה מעריכית רועדת, שמוגבלת לערך זה.

protectPlaceholders

סוג: boolean

ברירת המחדל היא true. כאשר פועלים, טוקנים כמו {{name}}, ${var}, {0}, {0:N2}, %s, %1$s ו-HTML מוחלפים בטוקנים של סנטינל לפני התרגום ומשוחזרים לאחר מכן. בטל רק כאשר המקור מכיל בכוונה מילוליים בצורת משאבים זמניים.

customPlaceholderPatterns

סוג: string[]

תבניות regex נוספות (ללא מגבילים) נוספו לסט הזמני ברירת המחדל, למשל <<.+?>> לתחביר טוקנים מותאם אישית. רגקסים לא תקפים מתעלמים מהם.

noTranslatePatterns

סוג: string[]

תבניות גלוב התאימו למפתחות ברמת המנתח (JSON dotted path, RESX name, PO msgid, XLIFF unit 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.
הערכים הממוזגים מאומתים. אנומים לא תקינים (למשל profanityAction: Mask) גורמים לפעולה להיכשל במהירות עם הודעה ברורה.

טון ותעשייה, במונחים פשוטים

ל-Azure AI Translator v3 API אין כפתור טון יחיד. שתי הגדרות משתלבות כדי לתת לך את רוב השליטה:

תעשייה / תחום: השתמש categoryId כדי להצביע על קטגוריית Azure Custom Translator שמאומנת על קורפוס משלך — משפטי, טכני, רפואי, שיווקי או כל דבר אחר. זהו המנוף החזק ביותר לטון, קול מותג ואוצר מילים.
טקסט שטחי: השתמשו מילון מונחים כדי לנעול שמות מותגים ומונחי מוצר במילה, והשתמשו profanityAction כדי למחוק מונחים גסים כאשר מכוונים ללוקליזציה לקהלים צעירים.

בחר את השפה שלך

תצורת מאגר

סכימה

התייחסות לשדה

סדר הטעינה

טון ותעשייה, במונחים פשוטים