translate
Справочник API по методу GT translate
Обзор
Метод translate — основная функция перевода в библиотеке GT.
Он переводит содержимое из исходной локали в указанную целевую локаль с использованием AI‑сервисов перевода.
const gt = new GT({
apiKey: 'your-api-key',
projectId: 'your-project-id'
});
const result = await gt.translate('Hello, world!', 'es');
console.log(result); // "¡Hola, mundo!"Метод поддерживает несколько типов контента, включая обычный текст, ICU‑сообщения и сообщения в стиле i18next, а также необязательные метаданные для повышения точности перевода.
Требуется аутентификация:
Для работы метода translate в экземпляре GT должны быть настроены apiKey (или devApiKey) и projectId.
Справка
Параметры
Метод translate имеет несколько перегрузок для различных типов контента:
Текстовое содержимое
Prop
Type
Контент JSX
Prop
Type
Формат сообщений ICU
Prop
Type
Формат i18next
Prop
Type
Описание параметров
| Параметр | Описание |
|---|---|
source | Содержимое для перевода. Может быть простым текстом, элементами JSX, сообщениями ICU или i18next |
targetLocale | Код локали по BCP‑47 для целевого языка (например, «es», «fr-CA») |
metadata | Необязательный контекст перевода, включая теги и параметры форматирования |
Возвращаемое значение
Promise<TranslationResult | TranslationError>- TranslationResult: Содержит переведённое содержимое и метаданные
- TranslationError: Содержит сведения об ошибке, если перевод завершился неудачей
Поведение
Определение типа контента
Метод автоматически определяет тип контента по параметру source:
- String: Рассматривается как обычный текст или сообщение в формате ICU
- JSX Elements: Обрабатывается как JSX‑контент в стиле React
- Objects: Обрабатывается как структурированный формат сообщения
Определение локали
- Целевая локаль проверяется на соответствие стандарту BCP‑47
- При наличии конфигурации применяются пользовательские сопоставления локалей
- Для запросов к API используются канонические коды локалей
Расширение контекста
Если в пользовательском сопоставлении для целевой локали указаны коды региона или письма, они автоматически добавляются в метаданные для повышения точности перевода.
Примеры
const gt = new GT({
apiKey: 'ваш-api-ключ',
projectId: 'ваш-project-id'
});
const result = await gt.translate('Добро пожаловать в наше приложение', 'fr');
console.log(result);
// "Bienvenue dans notre application"Примечания
- Переводит указанную строку в целевую локаль и возвращает промис
Дальнейшие шаги
Насколько полезно это руководство?