Получение сведений о поддерживаемых форматах документов
Справочная служба: версия API перевода документов ВИ Azure: версия 1.1
Метод получения поддерживаемых форматы документов возвращает список форматов документов, поддерживаемых службой перевода документов. Список содержит распространенные расширения имен файла и content-type при использовании API отправки.
Запросить URL-адрес
Отправьте запрос GET на следующий адрес.
GET https://<NAME-OF-YOUR-RESOURCE>.cognitiveservices.azure.com/translator/text/batch/v1.1/documents/formats
Узнайте, как найти свое личное доменное имя.
Внимание
- Конечную точку личного домена необходимо указывать во всех запросах API к службе перевода документов.
- Вы не можете использовать конечную точку, найденную на странице ключей и конечной точки ресурса портала Azure, или глобальную конечную точку переводчика—
api.cognitive.microsofttranslator.com—для выполнения HTTP-запросов к переводу документов.
Заголовки запросов
Заголовки запроса.
| Заголовки | Description |
|---|---|
| Ocp-Apim-Subscription-Key | Обязательный заголовок запроса |
Коды состояния ответа
Ниже приведены возможные коды состояния HTTP, которые возвращает запрос.
| Код состояния | Description |
|---|---|
| 200 | ОК. Возвращает список поддерживаемых форматов файлов документов. |
| 500 | Внутренняя ошибка сервера. |
| Другие коды состояния | • Слишком много запросов • Временный сервер недоступен |
Ответ формата файла
Успешный ответ fileFormatListResult
В успешном ответе возвращается следующая информация.
| Имя. | Тип | Описание |
|---|---|---|
| значение | FileFormat [] | FileFormat[] содержит перечисленные сведения. |
| value.contentTypes | string[] | Поддерживаемые типы содержимого для данного формата. |
| value.defaultVersion | строка | Версия по умолчанию, если значение не указано. |
| value.fileExtensions | string[] | Поддерживаемое расширение файла для данного формата. |
| 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 является примером успешного ответа.
Код состояния: 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": []
}
]
}
Пример ответа с ошибкой
Следующий объект JSON является примером ответа с ошибкой. Схема для других кодов ошибок такая же.
Код состояния: 500
{
"error": {
"code": "InternalServerError",
"message": "Internal Server Error",
"innerError": {
"code": "InternalServerError",
"message": "Unexpected internal server error has occurred"
}
}
}
Следующие шаги
Воспользуйтесь информацией, приведенной в данном кратком руководстве, чтобы узнать больше об использовании перевода документов и клиентской библиотеки.