Obtención de formatos de documento admitidos
El método de obtención de formatos de documentos admitidos devuelve una lista de formatos de documentos admitidos por el servicio de traducción de documentos. La lista incluye la extensión de archivos común y el tipo de contenido si se usa la API de carga.
URL de la solicitud
Envíe una solicitud GET a:
GET https://<NAME-OF-YOUR-RESOURCE>.cognitiveservices.azure.com/translator/text/batch/v1.0/documents/formats
Aprenda a encontrar su nombre de dominio personalizado.
Importante
- Todas las solicitudes de API al servicio de traducción de documentos requieren un punto de conexión de dominio personalizado.
- No usará el punto de conexión que se encuentra en la página Claves y punto de conexión del recurso en Azure Portal, ni el punto de conexión global del traductor (
api.cognitive.microsofttranslator.com) para realizar solicitudes HTTP de traducción de documentos.
Encabezados de solicitud
Los encabezados de solicitud son:
| encabezados | Descripción |
|---|---|
| Ocp-Apim-Subscription-Key | Encabezado de solicitud obligatorio |
Códigos de estado de respuesta
A continuación se indican los códigos de estado HTTP posibles que devuelve una solicitud.
| Código de estado | Descripción |
|---|---|
| 200 | Aceptar. Devuelve la lista de formatos de archivo de documentos admitidos. |
| 500 | Error interno del servidor. |
| Otros códigos de estado |
|
Respuesta del formato de archivo
Respuesta correcta de fileFormatListResult
En una respuesta correcta se devuelve la información siguiente.
| Nombre | Tipo | Descripción |
|---|---|---|
| value | FileFormat [] | FileFormat[] contiene los detalles siguientes. |
| value.contentTypes | string[] | Tipos de contenido admitidos para este formato. |
| value.defaultVersion | string | Versión predeterminada si no se especifica ninguna. |
| value.fileExtensions | string[] | Extensión de archivo admitido para este formato. |
| value.format | string | Nombre del formato. |
| value.versions | cadena [] | Versión admitida. |
Respuesta de error
| Nombre | Tipo | Descripción |
|---|---|---|
| código | string | Enumeraciones que contiene códigos de error de alto nivel. Valores posibles:
|
| message | string | Obtiene un mensaje de error de alto nivel. |
| innerError | InnerTranslationError | Nuevo formato de error interno que cumple las directrices de Cognitive Services API. Contiene las propiedades necesarias ErrorCode, message y las propiedades opcionales, target, details (par clave-valor), innerError (se puede anidar). |
| innerError.code | string | Obtiene la cadena de error de código. |
| innerError.message | string | Obtiene un mensaje de error de alto nivel. |
| innerError.target | string | Obtiene el origen del error. Por ejemplo, sería "documentos" o "id. de documento" en el caso de un documento no válido. |
Ejemplos
Ejemplo de respuesta correcta
Aquí se muestra un ejemplo de respuesta correcta.
Código de estado: 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": []
}
]
}
Ejemplo de respuesta con error
A continuación se presenta un ejemplo de una respuesta con error. El esquema de otros códigos de error es el mismo.
Código de estado: 500
{
"error": {
"code": "InternalServerError",
"message": "Internal Server Error",
"innerError": {
"code": "InternalServerError",
"message": "Unexpected internal server error has occurred"
}
}
}
Pasos siguientes
Siga nuestro inicio rápido para obtener más información sobre el uso de Traducción de documentos y la biblioteca cliente.