Переводчик 3.0: Detect (обнаружение)

Определяет язык для фрагмента текста.

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

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

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

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

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

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

Параметр запроса Описание
api-version Обязательный параметр.
Версия API, запрошенная клиентом. Необходимое значение: 3.0.

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

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

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

Текст запроса является массивом в формате JSON. Каждый элемент этого массива представляет собой объект JSON со строковым свойством Text. Определение языка применяется к значению свойства Text. Функция автоопределения языка лучше работает при вводе более длинного текста. Ниже представлен пример текста запроса.

[
    { "Text": "Ich würde wirklich gerne Ihr Auto ein paar Mal um den Block fahren." }
]

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

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

Текст ответа

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

  • language — код распознанного языка.

  • score — значение с плавающей запятой, обозначающее достоверность результата. Может принимать ноль или единицу, где низкая оценка обозначает низкую достоверность.

  • isTranslationSupported: логическое значение, равное true, если обнаруженный язык является одним из языков, поддерживаемых для перевода текста.

  • isTransliterationSupported: логическое значение, равное true, если обнаруженный язык является одним из языков, поддерживаемых для транслитерации.

  • alternatives — массив других возможных языков. Каждый элемент массива является другим объектом со следующими свойствами: language, isTranslationSupportedscoreи isTransliterationSupported.

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

[

    {

        "language": "de",

        "score": 1.0,

        "isTranslationSupported": true,

        "isTransliterationSupported": false

    }

]

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

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

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

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

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

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

Примеры

В следующем примере показано, как получить список языков, поддерживаемых для перевода текста.

curl -X POST "https://api.cognitive.microsofttranslator.com/detect?api-version=3.0" -H "Ocp-Apim-Subscription-Key: <client-secret>" -H "Content-Type: application/json" -d "[{'Text':'What language is this text written in?'}]"