Obtención de formatos de glosario admitidos
Característica de referencia
: Azure AI Translator → versión de Document Translation
API: 2024-05-01
MÉTODO HTTP: GET
Este método devuelve una lista de formatos de glosario admitidos por la característica traducción de documentos. La lista incluye las extensiones de archivo comunes.
URL de la solicitud
Importante
Todas las solicitudes de API a la característica de traducción de documentos requieren un punto de conexión de dominio personalizado que se encuentra en la página de información general del recurso en Azure Portal.
curl -i -X GET "{document-translation-endpoint}/translator/document/formats?api-version={date}&type=glossary"
Encabezados de solicitud
Los encabezados de solicitud son:
encabezados | Descripción | Condición |
---|---|---|
Ocp-Apim-Subscription-Key | La clave de API del servicio Translator desde Azure Portal. | Obligatorio |
Ocp-Apim-Subscription-Region | La región donde se creó el recurso. | Se requiere cuando se usa un recurso regional (geográfico) como Oeste de EE. UU. &viñeta. |
Content-Type | En este encabezado se especifica el tipo de contenido de la carga. Los valores que se aceptan son application/json o charset=UTF-8. | 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 glosario admitidos. |
500 | Error interno del servidor. |
Otros códigos de estado | • Demasiadas solicitudes • Servidor temporal no disponible |
Respuesta de obtención de formatos de glosario admitidos
Tipo base para la lista devuelta en la API de obtención de formatos de glosario admitidos.
Respuesta correcta de obtención de formatos de glosario admitidos
Tipo base para la lista devuelta en la API de obtención de formatos de glosario admitidos.
Nombre | Escribir | Descripción |
---|---|---|
value | FileFormat [] | FileFormat[] contiene la lista de los detalles. |
value.contentTypes | cadena [] | Tipos de contenido admitidos para este formato. |
value.defaultVersion | string | Versión predeterminada si no se especifica ninguna |
value.fileExtensions | cadena [] | Extensión de archivo admitido para este formato. |
value.format | string | Nombre del formato. |
value.versions | cadena [] | Versión admitida. |
Respuesta de error
Nombre | Escribir | Descripción |
---|---|---|
código | string | Enumeraciones que contiene códigos de error de alto nivel. Valores posibles: • InternalServerError • InvalidArgument • InvalidRequest • RequestRateTooHigh • ResourceNotFound • ServiceUnavailable •Desautorizado |
message | string | Obtiene un mensaje de error de alto nivel. |
innerError | InnerTranslationError | Nuevo formato de error interno, que cumple las directrices de la API de los servicios de Azure AI. Este mensaje de error contiene las propiedades necesarias ErrorCode, message y el destino de propiedades opcionales, details(key value pair), inner error(it can be nested). |
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 documents o document id si hubiera un documento inválido. |
Ejemplos
Ejemplo de respuesta correcta
El siguiente objeto JSON es un ejemplo de una respuesta correcta.
{
"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"
]
}
]
}
Ejemplo de respuesta con error
El siguiente objeto JSON es 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.