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

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

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

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

GET https://<NAME-OF-YOUR-RESOURCE>.cognitiveservices.azure.com/translator/text/batch/v1.0/documents/formats

Узнайте, как найти имя личного домена.

Важно!

  • Во всех запросах API к службе перевода документов необходимо указывать конечную точку личного домена.
  • Вы не можете использовать конечную точку, указанную на портале Azure на странице ресурса Ключи и конечная точка, и глобальную конечную точку перевода (api.cognitive.microsofttranslator.com) для создания HTTP-запросов к службе перевода документов.

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

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

Заголовки Описание
Ocp-Apim-Subscription-Key Обязательный заголовок запроса

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

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

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

Ответ формата файла

Успешный ответ fileFormatListResult

В случае успешного ответа возвращается следующая информация.

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

Сообщение об ошибке

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

Примеры

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

Ниже приведен пример успешного ответа.

Код состояния: 200.

{
    "value": [
        {
            "format": "PlainText",
            "fileExtensions": [
                ".txt"
            ],
            "contentTypes": [
                "text/plain"
            ],
            "versions": []
        },
        {
            "format": "OpenXmlWord",
            "fileExtensions": [
                ".docx"
            ],
            "contentTypes": [
                "application/vnd.openxmlformats-officedocument.wordprocessingml.document"
            ],
            "versions": []
        },
        {
            "format": "OpenXmlPresentation",
            "fileExtensions": [
                ".pptx"
            ],
            "contentTypes": [
                "application/vnd.openxmlformats-officedocument.presentationml.presentation"
            ],
            "versions": []
        },
        {
            "format": "OpenXmlSpreadsheet",
            "fileExtensions": [
                ".xlsx"
            ],
            "contentTypes": [
                "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"
            ],
            "versions": []
        },
        {
            "format": "OutlookMailMessage",
            "fileExtensions": [
                ".msg"
            ],
            "contentTypes": [
                "application/vnd.ms-outlook"
            ],
            "versions": []
        },
        {
            "format": "HtmlFile",
            "fileExtensions": [
                ".html",
                ".htm"
            ],
            "contentTypes": [
                "text/html"
            ],
            "versions": []
        },
        {
            "format": "PortableDocumentFormat",
            "fileExtensions": [
                ".pdf"
            ],
            "contentTypes": [
                "application/pdf"
            ],
            "versions": []
        },
        {
            "format": "XLIFF",
            "fileExtensions": [
                ".xlf"
            ],
            "contentTypes": [
                "application/xliff+xml"
            ],
            "versions": [
                "1.0",
                "1.1",
                "1.2"
            ]
        },
        {
            "format": "TSV",
            "fileExtensions": [
                ".tsv",
                ".tab"
            ],
            "contentTypes": [
                "text/tab-separated-values"
            ],
            "versions": []
        },
        {
            "format": "CSV",
            "fileExtensions": [
                ".csv"
            ],
            "contentTypes": [
                "text/csv"
            ],
            "versions": []
        },
        {
            "format": "RichTextFormat",
            "fileExtensions": [
                ".rtf"
            ],
            "contentTypes": [
                "application/rtf"
            ],
            "versions": []
        },
        {
            "format": "WordDocument",
            "fileExtensions": [
                ".doc"
            ],
            "contentTypes": [
                "application/msword"
            ],
            "versions": []
        },
        {
            "format": "PowerpointPresentation",
            "fileExtensions": [
                ".ppt"
            ],
            "contentTypes": [
                "application/vnd.ms-powerpoint"
            ],
            "versions": []
        },
        {
            "format": "ExcelSpreadsheet",
            "fileExtensions": [
                ".xls"
            ],
            "contentTypes": [
                "application/vnd.ms-excel"
            ],
            "versions": []
        },
        {
            "format": "OpenDocumentText",
            "fileExtensions": [
                ".odt"
            ],
            "contentTypes": [
                "application/vnd.oasis.opendocument.text"
            ],
            "versions": []
        },
        {
            "format": "OpenDocumentPresentation",
            "fileExtensions": [
                ".odp"
            ],
            "contentTypes": [
                "application/vnd.oasis.opendocument.presentation"
            ],
            "versions": []
        },
        {
            "format": "OpenDocumentSpreadsheet",
            "fileExtensions": [
                ".ods"
            ],
            "contentTypes": [
                "application/vnd.oasis.opendocument.spreadsheet"
            ],
            "versions": []
        },
        {
            "format": "Markdown",
            "fileExtensions": [
                ".markdown",
                ".mdown",
                ".mkdn",
                ".md",
                ".mkd",
                ".mdwn",
                ".mdtxt",
                ".mdtext",
                ".rmd"
            ],
            "contentTypes": [
                "text/markdown",
                "text/x-markdown",
                "text/plain"
            ],
            "versions": []
        },
        {
            "format": "Mhtml",
            "fileExtensions": [
                ".mhtml",
                ".mht"
            ],
            "contentTypes": [
                "message/rfc822",
                "application/x-mimearchive",
                "multipart/related"
            ],
            "versions": []
        }
    ]
}

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

Ниже приведен пример ответа с ошибкой. Схема для других кодов ошибок такая же.

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

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

Дальнейшие действия

Чтобы узнать больше об использовании службы перевода документов и клиентской библиотеки, обратитесь к нашему краткому руководству.