Entradas y salidas · Traductor de recursos

Consulta Configuración para el esquema YAML y el orden de carga.

Entradas requeridas

sourceLocale

Localidad de origen (por ejemplo, en) utilizada para encontrar archivos de recursos como **/*.en.resx. También se remitió al proveedor como from=<locale>.

Selección de proveedores y credenciales

Elige un proveedor por cada partida con provider. Proporciona solo las credenciales del proveedor seleccionado — consulta la guía Entradas y salidas para la configuración completa.

provider

Default: azure

Proveedor de traducción: azure (por defecto), aws o google. Solo se utiliza un proveedor por llamada de acción.

subscriptionKey

Default: ninguno

Clave de suscripción Azure AI Translator. Obligatorio para azure. Pasa por secrets.

endpoint

Default: ninguno

URL de endpoint de Azure Translator, por ejemplo, https://api.cognitive.microsofttranslator.com/. Obligatorio para azure.

awsAccessKeyId

Default: ninguno

ID de clave de acceso AWS. Opcional — omitir (con awsSecretAccessKey) usar la cadena de credenciales predeterminada de AWS / OIDC. Pasa por secrets.

awsSecretAccessKey

Default: ninguno

Clave de acceso secreto de AWS. Debe ser suministrado junto con awsAccessKeyId. Pasa por secrets.

awsSessionToken

Default: ninguno

Token de sesión AWS opcional para credenciales temporales. Pasa por secrets.

awsRegion

Default: ninguno

Región AWS para el servicio Translate (por ejemplo, us-east-1). Obligatorio para aws a menos que AWS_REGION esté ambientado en el entorno.

awsFormality

Default: ninguno

AWS Translate formality setting: FORMAL or INFORMAL.

awsBrevity

Default: ninguno

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

awsTerminologyNames

Default: ninguno

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

awsParallelDataNames

Default: ninguno

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

googleApiKey

Default: ninguno

Clave API de Google Cloud. Proporciona este googleCredentials de quirófano para google. Pasa por secrets.

googleCredentials

Default: ninguno

Clave de cuenta de servicio en Google Cloud como cadena JSON. Proporciona este googleApiKey de quirófano para google. Pasa por secrets.

googleProjectId

Default: ninguno

ID de proyecto opcional en Google Cloud. Normalmente se infiere a partir de la credencial de la cuenta de servicio.

googleModel

Default: ninguno

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

googleApiEndpoint

Default: ninguno

Optional Google Cloud Translation API endpoint override.

googleAutoRetry

Default: ninguno

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

Entradas opcionales comunes

region

Default: ninguno

Región de recursos traductores (omitir recursos globales).

toLocales

Default: todos apoyados

Lugares a los que traducir. Acepta un array JSON (["fr","de"]) o valores separados por comas.

include

Default: ninguno

Patrones de globos separados por líneas de newline; solo se traducen los archivos coincidentes.

exclude

Default: ninguno

Patrones de globos separados por líneas de newline; Los archivos coincidentes se saltan (se aplican después de incluir).

configPath

Default: .github/resource-translator.yml

Ruta hacia el archivo de configuración YAML (relativo a la raíz del espacio de trabajo).

changeDetection

Default: 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

Default: .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

Default: 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

Default: false

Cuando true, ejecuta traducciones y emite resúmenes, pero no escribas archivos.

failOnError

Default: true

Cuando true, errores inesperados fallan la acción; Cuando false, los errores son advertencias.

Entradas de solicitud de Azure Translator

Estos se asignan directamente a los parámetros de consulta de Azure AI Translator v3 y se aplican al proveedor de Azure. textType y profanityAction también se asignan a AWS/Google donde existe un equivalente (véase la guía de proveedores); el resto son solo Azure. Cada uno es opcional; los valores predeterminados del traductor se aplican cuando no se activan.

categoryId

Default: general

Azure Custom Translator category — el perillón industry/domain/tone. Reenviado como ?category=....

textType

Default: plain

plain o html. Usa html solo cuando los valores de tus recursos sean fragmentos HTML reales.

profanityAction

Default: NoAction

NoAction, Marked o Deleted. Controla cómo se emiten los términos profanos en las traducciones.

profanityMarker

Default: Asterisk

Asterisk o Tag. Solo significa profanityAction es Marked.

allowFallback

Default: true (Traductor por defecto)

Cuando false, el traductor devuelve un error en lugar de volver al sistema general si tu categoryId no tiene despliegue para una localización objetivo.

apiVersion

Default: 3.0

Versión de la API REST del traductor.

Resiliencia y protección provisional

Estas entradas controlan cómo se comporta la acción cuando Traductor limita tu solicitud y cómo protege tokens marcadores como {{name}} o {0} de ser alterados durante la traducción.

maxRetries

Default: 5

Intentos máximos de reintentos en respuestas HTTP transitorias (408, 425, 429, 500, 502, 503, 504). El número total de llamadas HTTP por solicitud es 1 + maxRetries.

retryBackoffMs

Default: 30000

Limita (en milisegundos) cualquier sueño de retroceso individual. La acción honra el encabezado de respuesta Retry-After de Azure exactamente cuando está presente; de lo contrario, utiliza un retroceso exponencial con jitters limitado a este valor.

protectPlaceholders

Default: true

Cuando true (por defecto), los marcadores de posición como {{name}}, ${var}, {0}, {0:N2}, %s, %1$s y HTML se reemplazan por tokens centinela antes de la traducción y se restauran después. Desactiva solo cuando tu fuente contiene intencionadamente texto literal en forma de marcador que deba traducirse.

customPlaceholderPatterns

Default: ninguno

Regexes separados por nueva línea (sin delimitadores) añadidos al conjunto de marcadores predeterminados, por ejemplo, <<.+?>> para sintaxis personalizada de tokens.

noTranslatePatterns

Default: ninguno

Los patrones de globos separados por nueva línea coincidían con las claves a nivel de analizador (JSON doted path, RESX name, PO msgid, unidad XLIFF id, clave INI/restext). Las claves coincidentes se eliminan de la solicitud del traductor y pasan manteniendo su valor fuente.

Salidas

summary-title

Resumen breve y amigable para el título de relaciones públicas, por ejemplo, Machine-translated 320 files, a total of 5,418 translations.

summary-details

Resumen de descuento adecuado para un organismo de relaciones públicas o un resumen de puesto.

has-new-translations

'true' cuando se generaban una o más nuevas traducciones.