Перевод текстов 3.0: BreakSentence

Статья
09/01/2024

Определяет расположение границ предложения в фрагменте текста.

Запросить URL-адрес

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

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

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

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

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

Параметр запроса	Description
Версия AP	Обязательный параметр запроса. Версия API, запрошенная клиентом. Необходимое значение: `3.0`.
язык	Необязательный параметр запроса. Тег языка, определяющий язык входного текста. Если код не указан, применяется автоматическое обнаружение языка.
Скрипт	Необязательный параметр запроса. Тег набора символов, определяющий набор символов, используемый во входном тексте. Если скрипт не указан, предполагается сценарий по умолчанию языка.

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

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

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

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

[
    { "Text": "How are you? I am fine. What did you do today?" }
]

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

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

Текст ответа

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

sentLen — массив целых чисел, представляющих значения длины предложений в текстовом элементе. Длина массива соответствует количеству предложений, а значения — длине каждого предложения.
detectedLanguage — объект, описывающий распознанный язык с помощью следующих свойств:
- language — код распознанного языка.
- score — значение с плавающей запятой, обозначающее достоверность результата. Оценка составляет от нуля (0) до одного (1,0). Низкая оценка (<= 0,4) указывает на низкую достоверность.

Свойство detectedLanguage присутствует в объекте результата исключительно при запросе автоопределения языка.

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

[
    {
        "detectedLanguage": {
            "language": "en",
            "score": 1.0
        },
        "sentLen": [
            13,
            11,
            22
        ]
    }
]

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

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

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

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

Код состояния	Description
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/breaksentence?api-version=3.0" -H "Ocp-Apim-Subscription-Key: <client-secret>" -H "Content-Type: application/json" -d "[{'Text':'How are you? I am fine. What did you do today?'}]"

Поделиться через