Получение сведений о поддерживаемых форматах глоссария

Статья
06/01/2024

Справочная функция: API перевода
документов в Azure Переводчик →: метод HTTP 2024-05-01
: GET

Этот метод возвращает список форматов глоссарий, поддерживаемых функцией перевода документов. Список включает общие расширения файлов.

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

Внимание

Для всех запросов API к функции перевода документов требуется конечная точка личного домена, расположенная на странице обзора ресурсов в портал Azure.

curl -i -X GET "{document-translation-endpoint}/translator/document/formats?api-version={date}&type=glossary"

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

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

Заголовки	Description	Условие
Ocp-Apim-Subscription-Key	Ключ API службы Переводчик из портал Azure.	Обязательное поле
Ocp-Apim-Subscription-Region	Регион, в котором был создан ресурс.	• Требуется при использовании регионального (географического) ресурса, например западной части США. &маркер.
Content-Type	Тип содержимого для полезных данных. Допустимые значения: application/json или charset=UTF-8.	• Требуется

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

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

Код состояния	Description
200	ОК. Возвращает список поддерживаемых форматов файлов глоссария.
500	Внутренняя ошибка сервера.
Другие коды состояния	• Слишком много запросов • Временный сервер недоступен

Получить ответ о поддерживаемых форматах глоссария

Базовый тип для возврата списка в API получения поддерживаемых форматов глоссария.

Успешный ответ на получение поддерживаемых форматов глоссария

Базовый тип для возврата списка в API получения поддерживаемых форматов глоссария.

Имя.	Тип	Описание
значение	FileFormat []	FileFormat[] содержит перечисленные сведения.
value.contentTypes	строка []	Поддерживаемые типы содержимого для данного формата.
value.defaultVersion	строка	Версия по умолчанию, если значение не указано.
value.fileExtensions	строка []	Поддерживаемое расширение файла для данного формата.
value.format	строка	Название формата.
value.versions	строка []	Поддерживаемая версия.

Отклик в случае ошибки

Имя.	Тип	Описание
кодом	строка	Перечисления, содержащие коды ошибок высокого уровня. Возможные значения: • InternalServerError • InvalidArgument • InvalidRequest • RequestRateTooHigh • ResourceNotFound • ServiceUnavailable •Несанкционированного
message	строка	Получает сообщение об ошибке высокого уровня.
innerError	InnerTranslationError	Новый формат внутренней ошибки, соответствующий рекомендациям ПО API служб искусственного интеллекта Azure. Это сообщение об ошибке содержит обязательные свойства ErrorCode, message и необязательные свойства, сведения (пара "значение ключа"), внутреннюю ошибку (ее можно вложить).
innerError.code	строка	Получает строку с ошибкой кода.
innerError.message	строка	Получает сообщение об ошибке высокого уровня.
innerError.target	строка	Получает источник ошибки. Например, это будет `documents` или `document id` , если был недопустимый документ.

Примеры

Пример успешного ответа

Следующий объект JSON является примером успешного ответа.

{
    "value": [
        {
            "format": "XLIFF",
            "fileExtensions": [
                ".xlf"
            ],
            "contentTypes": [
                "application/xliff+xml"
            ],
            "defaultVersion": "1.2",
            "versions": [
                "1.0",
                "1.1",
                "1.2"
            ]
        },
        {
            "format": "TSV",
            "fileExtensions": [
                ".tsv",
                ".tab"
            ],
            "contentTypes": [
                "text/tab-separated-values"
            ]
        },
        {
            "format": "CSV",
            "fileExtensions": [
                ".csv"
            ],
            "contentTypes": [
                "text/csv"
            ]
        }
    ]
}

Пример ответа с ошибкой

Следующий объект JSON является примером ответа с ошибкой. Схема для других кодов ошибок такая же.

Код состояния: 500

{
  "error": {
    "code": "InternalServerError",
    "message": "Internal Server Error",
    "innerError": {
      "code": "InternalServerError",
      "message": "Unexpected internal server error has occurred"
    }
  }
}

Следующие шаги

Воспользуйтесь информацией, приведенной в данном кратком руководстве, чтобы узнать больше об использовании перевода документов и клиентской библиотеки.

Начало работы с функцией перевода документов

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