Переводчик 3.0: транслитерация

Преобразует текст на одном языке из одного набора символов в другой.

URL-адрес запроса

Отправьте запрос POST на следующий адрес.

https://api.cognitive.microsofttranslator.com/transliterate?api-version=3.0

Смвиртуальная сеть поддержка выбранной сети и частной конечной точки службы Переводчика.

Параметры запроса

В таблице ниже приведены параметры, которые передаются в строке запроса.

Параметр запроса Описание
api-version Обязательный параметр.
Версия API, запрошенная клиентом. Необходимое значение: 3.0.
Язык Обязательный параметр.
Указывает язык текста, преобразуемого из одного набора символов в другой. Возможные языки перечисляются в области transliteration, получаемой путем отправки запроса к службе на предмет поддерживаемых языков.
fromScript Обязательный параметр.
Указывает набор символов, используемый во входном тексте. Определите поддерживаемые языки с помощью области transliteration, чтобы найти доступные входные наборы символов для выбранного языка.
toScript Обязательный параметр.
Указывает выходной набор символов. Определите поддерживаемые языки с помощью области transliteration, чтобы найти доступные выходные наборы символов для выбранного сочетания входного языка и входного набора символов.

Заголовки запроса:

Заголовки Описание
Заголовки для проверки подлинности Обязательный заголовок запроса.
См. описание доступных способов аутентификации.
Content-Type Обязательный заголовок запроса.
Указывает тип содержимого для полезных данных. Возможные значения: application/json
Content-Length Обязательный заголовок запроса.
Длина текста запроса.
X-ClientTraceId Необязательно.
Созданный клиентом идентификатор GUID, позволяющий уникально идентифицировать запрос. Этот заголовок можно опустить, если в строке запроса указан идентификатор трассировки в параметре с именем ClientTraceId.

Текст запроса

Текст запроса является массивом в формате JSON. Каждый элемент этого массива представляет собой объект JSON со строковым свойством Text, который соответствует преобразуемой строке.

[
    {"Text":"こんにちは"},
    {"Text":"さようなら"}
]

Действительны следующие ограничения.

  • Массив может содержать не более 10 элементов.
  • Текстовое значение элемента массива не может превышать 1000 символов, включая пробелы.
  • Весь текст, включенный в запрос, не может превышать 5000 символов, включая пробелы.

Текст ответа

Успешный ответ возвращается в формате массива JSON с одним результатом для каждого элемента входного массива. Объект результата содержит следующие свойства.

  • text: строка, полученная в результате преобразования входной строки в выходной скрипт.

  • script: строка, указывающая набор символов, используемый в выходных данных.

Пример ответа в формате JSON:

[
    {"text":"konnnichiha","script":"Latn"},
    {"text":"sayounara","script":"Latn"}
]

Заголовки ответов

Заголовки Описание
X-RequestId Сформированное службой значение для идентификации запроса. Используется для устранения неполадок.

Коды состояния ответа

Ниже приведены возможные коды состояния HTTP, которые возвращает запрос.

Код состояния Описание
200 Успешно.
400 Один из параметров запроса отсутствует или является недопустимым. Исправьте параметры запроса и повторите попытку.
401 Не удалось выполнить аутентификацию запроса. Убедитесь, что указаны допустимые учетные данные.
403 Запрос не авторизован. Подробные сведения можно найти в сообщении об ошибке. Этот код часто указывает, что все бесплатные переводы, предоставляемые с пробной подпиской, были использованы.
429 Сервер отклонил запрос, так как клиент превысил ограничения для запросов.
500 Произошла непредвиденная ошибка. Если ошибка сохраняется, передайте отчет о ней, включив следующие данные: дата и время сбоя, идентификатор запроса из заголовка ответа X-RequestId и идентификатор клиента из заголовка запроса X-ClientTraceId.
503 Сервер временно недоступен. Повторите запрос. Если ошибка сохраняется, передайте отчет о ней, включив следующие данные: дата и время сбоя, идентификатор запроса из заголовка ответа X-RequestId и идентификатор клиента из заголовка запроса X-ClientTraceId.

Если возникнет ошибка, запрос также вернет ответ JSON с ошибкой. Код ошибки представляет собой число из 6 знаков, первые 3 из которых являются кодом состояния HTTP, а оставшиеся 3 цифры определяют категорию ошибки. Коды распространенных ошибок можно найти на справочной странице переводчика версии 3.

Примеры

В следующем примере показано преобразование двух строк на японском языке в транслитерацию японского текста латиницей.

Полезные данные JSON для запроса в этом примере:

[{"text":"こんにちは","script":"jpan"},{"text":"さようなら","script":"jpan"}]

Если вы используете cURL в окне командной строки, которое не поддерживает символы Юникода, возьмите следующие полезные данные JSON и сохраните их в файл с именем request.txt. Обязательно сохраните файл в кодировке UTF-8.

curl -X POST "https://api.cognitive.microsofttranslator.com/transliterate?api-version=3.0&language=ja&fromScript=Jpan&toScript=Latn" -H "X-ClientTraceId: 875030C7-5380-40B8-8A03-63DACCF69C11" -H "Ocp-Apim-Subscription-Key: <client-secret>" -H "Content-Type: application/json" -d @request.txt